PreferredWidth

PreferredWidth class

Представляет значение и его единицу измерения, которые используются для указания предпочтительной ширины таблицы или ячейки.

public sealed class PreferredWidth

Характеристики

Имя Описание
Type { get; } Получает единицу измерения, используемую для этого предпочтительного значения ширины.
Value { get; } Получает предпочтительное значение ширины. Единица измерения указана вType свойство.

Методы

Имя Описание
static FromPercent(double) Метод создания, который возвращает новый экземпляр, представляющий предпочтительную ширину, указанную в процентах.
static FromPoints(double) Метод создания, который возвращает новый экземпляр, представляющий предпочтительную ширину, указанную с помощью количества точек.
override Equals(object) Определяет, равен ли указанный объект по значению текущему объекту.
Equals(PreferredWidth) Определяет, равна ли указанная PreferredWidth по значению текущей PreferredWidth.
override GetHashCode() Служит хэш-функцией для этого типа.
override ToString() Возвращает удобную для пользователя строку, отображающую значение этого объекта.

Поля

Имя Описание
static readonly Auto Возвращает экземпляр, представляющий значение “предпочтительная ширина не указана”.

Примечания

Предпочтительная ширина может быть указана в процентах, количестве точек или специальном значении «нет/авто».

Экземпляры этого класса неизменяемы.

Примеры

Показывает, как настроить таблицу так, чтобы она автоматически подгонялась под 50 % ширины страницы.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Table table = builder.StartTable();
builder.InsertCell();
builder.Write("Cell #1");
builder.InsertCell();
builder.Write("Cell #2");
builder.InsertCell();
builder.Write("Cell #3");

table.PreferredWidth = PreferredWidth.FromPercent(50);

doc.Save(ArtifactsDir + "DocumentBuilder.InsertTableWithPreferredWidth.docx");

Показывает, как установить предпочтительную ширину для ячеек таблицы.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Table table = builder.StartTable();

// Существует два способа применения класса PreferredWidth к ячейкам таблицы.
// 1 - Установить абсолютную предпочтительную ширину в пунктах:
builder.InsertCell();
builder.CellFormat.PreferredWidth = PreferredWidth.FromPoints(40);
builder.CellFormat.Shading.BackgroundPatternColor = Color.LightYellow;
builder.Writeln($"Cell with a width of {builder.CellFormat.PreferredWidth}.");

// 2 - Установите относительную предпочтительную ширину в процентах от ширины таблицы:
builder.InsertCell();
builder.CellFormat.PreferredWidth = PreferredWidth.FromPercent(20);
builder.CellFormat.Shading.BackgroundPatternColor = Color.LightBlue;
builder.Writeln($"Cell with a width of {builder.CellFormat.PreferredWidth}.");

builder.InsertCell();

// Ячейка, для которой не указана предпочтительная ширина, займет оставшееся доступное пространство.
builder.CellFormat.PreferredWidth = PreferredWidth.Auto;

// Каждая конфигурация свойства PreferredWidth создает новый объект.
Assert.AreNotEqual(table.FirstRow.Cells[1].CellFormat.PreferredWidth.GetHashCode(),
    builder.CellFormat.PreferredWidth.GetHashCode());

builder.CellFormat.Shading.BackgroundPatternColor = Color.LightGreen;
builder.Writeln("Automatically sized cell.");

doc.Save(ArtifactsDir + "DocumentBuilder.InsertCellsWithPreferredWidths.docx");

Смотрите также