FieldDocVariable
Contenu
[
Cacher
]FieldDocVariable class
Implémente le champ DOCVARIABLE.
Pour en savoir plus, visitez leTravailler avec des champs article documentaire.
public class FieldDocVariable : Field
Constructeurs
| Nom | La description |
|---|---|
| FieldDocVariable() | Default_Constructor |
Propriétés
| Nom | La description |
|---|---|
| DisplayResult { get; } | Obtient le texte qui représente le résultat du champ affiché. |
| End { get; } | Obtient le nœud qui représente la fin du champ. |
| Format { get; } | Obtient unFieldFormat objet qui fournit un accès typé au formatage du champ. |
| 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). |
| 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. |
| VariableName { get; set; } | Obtient ou définit le nom de la variable de document à récupérer. |
Méthodes
| Nom | La 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. |
Exemples
Montre comment utiliser les champs DOCPROPERTY pour afficher les propriétés et les variables du document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Vous trouverez ci-dessous deux manières d'utiliser les champs DOCPROPERTY.
// 1 - Afficher une propriété intégrée :
// Définissez une valeur personnalisée pour la propriété intégrée "Catégorie", puis insérez un champ DOCPROPERTY qui y fait référence.
doc.BuiltInDocumentProperties.Category = "My category";
FieldDocProperty fieldDocProperty = (FieldDocProperty)builder.InsertField(" DOCPROPERTY Category ");
fieldDocProperty.Update();
Assert.AreEqual(" DOCPROPERTY Category ", fieldDocProperty.GetFieldCode());
Assert.AreEqual("My category", fieldDocProperty.Result);
builder.InsertParagraph();
// 2 - Afficher une variable de document personnalisée :
// Définissez une variable personnalisée, puis référencez cette variable avec un champ DOCPROPERTY.
Assert.That(doc.Variables, Is.Empty);
doc.Variables.Add("My variable", "My variable's value");
FieldDocVariable fieldDocVariable = (FieldDocVariable)builder.InsertField(FieldType.FieldDocVariable, true);
fieldDocVariable.VariableName = "My Variable";
fieldDocVariable.Update();
Assert.AreEqual(" DOCVARIABLE \"My Variable\"", fieldDocVariable.GetFieldCode());
Assert.AreEqual("My variable's value", fieldDocVariable.Result);
doc.Save(ArtifactsDir + "Field.DOCPROPERTY.DOCVARIABLE.docx");
Voir également
- class Field
- espace de noms Aspose.Words.Fields
- Assemblée Aspose.Words
