PreferredWidth

PreferredWidth class

Représente une valeur et son unité de mesure utilisée pour spécifier la largeur préférée d’un tableau ou d’une cellule.

Pour en savoir plus, visitez leTravailler avec des tableaux article documentaire.

public sealed class PreferredWidth

Propriétés

NomLa description
Type { get; }Obtient l’unité de mesure utilisée pour cette valeur de largeur préférée.
Value { get; }Obtient la valeur de largeur préférée. L’unité de mesure est spécifiée dans leType propriété.

Méthodes

NomLa description
static FromPercent(double)Une méthode de création qui renvoie une nouvelle instance qui représente une largeur préférée spécifiée sous forme de pourcentage.
static FromPoints(double)Une méthode de création qui renvoie une nouvelle instance qui représente une largeur préférée spécifiée à l’aide d’un nombre de points.
override Equals(object)Détermine si l’objet spécifié a une valeur égale à l’objet actuel.
Equals(PreferredWidth)Détermine si lePreferredWidth est égale en valeur au courantPreferredWidth .
override GetHashCode()Sert de fonction de hachage pour ce type.
override ToString()Renvoie une chaîne conviviale qui affiche la valeur de cet objet.

Des champs

NomLa description
static readonly AutoRenvoie une instance qui représente la valeur « la largeur préférée n’est pas spécifiée ».

Remarques

La largeur préférée peut être spécifiée sous forme de pourcentage, de nombre de points ou d’une valeur spéciale « aucun/auto ».

Les instances de cette classe sont immuables.

Exemples

Montre comment définir un tableau pour qu’il s’ajuste automatiquement à 50 % de la largeur de la page.

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");

Montre comment définir une largeur préférée pour les cellules du tableau.

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

// Il existe deux manières d'appliquer la classe "PreferredWidth" aux cellules d'un tableau.
// 1 - Définit une largeur préférée absolue basée sur les points :
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 - Définit une largeur préférée relative basée sur le pourcentage de la largeur du tableau :
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();

// Une cellule sans largeur préférée spécifiée occupera le reste de l'espace disponible.
builder.CellFormat.PreferredWidth = PreferredWidth.Auto;

// Chaque configuration de la propriété "PreferredWidth" crée un nouvel objet.
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");

Voir également

CellVerticalAlignment Enum PreferredWidthType Enum