FieldSymbol

FieldSymbol class

Implémente un champ SYMBOLE.

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

public class FieldSymbol : Field

Constructeurs

NomLa description
FieldSymbol()Default_Constructor

Propriétés

NomLa description
CharacterCode { get; set; }Obtient ou définit la valeur du point de code du caractère en décimal ou hexadécimal.
DisplayResult { get; }Obtient le texte qui représente le résultat du champ affiché.
DontAffectsLineSpacing { get; set; }Obtient ou définit si le caractère récupéré par le champ affecte l’interligne du paragraphe.
End { get; }Obtient le nœud qui représente la fin du champ.
FontName { get; set; }Obtient ou définit le nom de la police du caractère récupéré par le champ.
FontSize { get; set; }Obtient ou définit la taille en points de la police du caractère récupéré par le champ.
Format { get; }Obtient unFieldFormat objet qui fournit un accès typé au formatage du champ.
IsAnsi { get; set; }Obtient ou définit si le code de caractère est interprété comme la valeur d’un caractère ANSI.
IsDirty { get; set; }Obtient ou définit si le résultat actuel du champ n’est plus correct (périmé) en raison d’autres modifications apportées au document.
IsLocked { get; set; }Obtient ou définit si le champ est verrouillé (ne doit pas recalculer son résultat).
IsShiftJis { get; set; }Obtient ou définit si le code de caractère est interprété comme la valeur d’un caractère SHIFT-JIS.
IsUnicode { get; set; }Obtient ou définit si le code de caractère est interprété comme la valeur d’un caractère Unicode.
LocaleId { get; set; }Obtient ou définit le LCID du champ.
Result { get; set; }Obtient ou définit le texte situé entre le séparateur de champ et la fin du champ.
Separator { get; }Obtient le nœud qui représente le séparateur de champ. Peut êtrenul .
Start { get; }Obtient le nœud qui représente le début du champ.
virtual Type { get; }Obtient le type de champ Microsoft Word.

Méthodes

NomLa description
GetFieldCode()Renvoie le texte entre le début du champ et le séparateur de champ (ou la fin du champ s’il n’y a pas de séparateur). Le code de champ et le résultat du champ des champs enfants sont inclus.
GetFieldCode(bool)Renvoie le texte entre le début du champ et le séparateur de champ (ou la fin du champ s’il n’y a pas de séparateur).
Remove()Supprime le champ du document. Renvoie un nœud juste après le champ. Si la fin du champ est le dernier child de son nœud parent, renvoie son paragraphe parent. Si le champ est déjà supprimé, renvoienul .
Unlink()Effectue la dissociation du champ.
Update()Effectue la mise à jour du champ. Lance si le champ est déjà mis à jour.
Update(bool)Effectue une mise à jour du champ. Lance si le champ est déjà mis à jour.

Remarques

Récupère le caractère dont la valeur du point de code est spécifiée en décimal ou en hexadécimal.

Exemples

Montre comment utiliser le champ SYMBOLE.

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

// Vous trouverez ci-dessous trois façons d'utiliser un champ SYMBOL pour afficher un seul caractère.
// 1 - Ajoutez un champ SYMBOLE qui affiche le symbole © (Copyright), spécifié par un code de caractère ANSI :
FieldSymbol field = (FieldSymbol)builder.InsertField(FieldType.FieldSymbol, true);

// Le code de caractère ANSI "U+00A9", ou "169" sous forme entière, est réservé au symbole de droit d'auteur.
field.CharacterCode = 0x00a9.ToString();
field.IsAnsi = true;

Assert.AreEqual(" SYMBOL  169 \\a", field.GetFieldCode());

builder.Writeln(" Line 1");

// 2 - Ajoutez un champ SYMBOLE qui affiche le symbole ∞ (Infini), et modifiez son apparence :
field = (FieldSymbol)builder.InsertField(FieldType.FieldSymbol, true);

// En Unicode, le symbole de l'infini occupe le code "221E".
field.CharacterCode = 0x221E.ToString();
field.IsUnicode = true;

// Change la police de notre symbole après avoir utilisé la table de caractères Windows
// pour garantir que la police peut représenter ce symbole.
field.FontName = "Calibri";
field.FontSize = "24";

// Nous pouvons définir cet indicateur pour les symboles de grande taille afin qu'ils ne poussent pas le reste du texte sur leur ligne.
field.DontAffectsLineSpacing = true;

Assert.AreEqual(" SYMBOL  8734 \\u \\f Calibri \\s 24 \\h", field.GetFieldCode());

builder.Writeln("Line 2");

// 3 - Ajout d'un champ SYMBOLE qui affiche le caractère あ,
// avec une police prenant en charge la page de codes Shift-JIS (Windows-932) :
field = (FieldSymbol)builder.InsertField(FieldType.FieldSymbol, true);
field.FontName = "MS Gothic";
field.CharacterCode = 0x82A0.ToString();
field.IsShiftJis = true;

Assert.AreEqual(" SYMBOL  33440 \\f \"MS Gothic\" \\j", field.GetFieldCode());

builder.Write("Line 3");

doc.Save(ArtifactsDir + "Field.SYMBOL.docx");

Voir également

FieldSubject Class FieldTA Class