FieldRD
Inhalt
[
Ausblenden
]FieldRD class
Implementiert das RD-Feld.
Um mehr zu erfahren, besuchen Sie dieArbeiten mit Feldern Dokumentationsartikel.
public class FieldRD : Field
Konstrukteure
| Name | Beschreibung |
|---|---|
| FieldRD() | Default_Constructor |
Eigenschaften
| Name | Beschreibung |
|---|---|
| DisplayResult { get; } | Ruft den Text ab, der das angezeigte Feldergebnis darstellt. |
| End { get; } | Ruft den Knoten ab, der das Feldende darstellt. |
| FileName { get; set; } | Ruft den Namen der Datei ab, die beim Generieren eines Inhaltsverzeichnisses, Autoritätsverzeichnisses oder Index einbezogen werden soll, oder legt diesen fest. |
| Format { get; } | Ruft a abFieldFormat Objekt, das typisierten Zugriff auf die Formatierung des Felds bietet. |
| IsDirty { get; set; } | Ruft ab oder legt fest, ob das aktuelle Ergebnis des Felds aufgrund anderer am Dokument vorgenommener Änderungen nicht mehr korrekt (veraltet) ist. |
| IsLocked { get; set; } | Ruft ab oder legt fest, ob das Feld gesperrt ist (sollte sein Ergebnis nicht neu berechnen). |
| IsPathRelative { get; set; } | Ruft ab oder legt fest, ob der Pfad relativ zum aktuellen Dokument ist. |
| LocaleId { get; set; } | Ruft die LCID des Felds ab oder legt sie fest. |
| Result { get; set; } | Ruft Text ab, der zwischen dem Feldtrennzeichen und dem Feldende liegt, oder legt diesen fest. |
| Separator { get; } | Ruft den Knoten ab, der das Feldtrennzeichen darstellt. Kann seinNull . |
| Start { get; } | Ruft den Knoten ab, der den Anfang des Felds darstellt. |
| virtual Type { get; } | Ruft den Microsoft Word-Feldtyp ab. |
Methoden
| Name | Beschreibung |
|---|---|
| GetFieldCode() | Gibt Text zwischen Feldanfang und Feldtrennzeichen zurück (oder Feldende, wenn kein Trennzeichen vorhanden ist). Sowohl der Feldcode als auch das Feldergebnis der untergeordneten Felder sind enthalten. |
| GetFieldCode(bool) | Gibt Text zwischen Feldanfang und Feldtrennzeichen zurück (oder Feldende, wenn kein Trennzeichen vorhanden ist). |
| Remove() | Entfernt das Feld aus dem Dokument. Gibt einen Knoten direkt nach dem Feld zurück. Wenn das Ende des Felds das letzte child seines übergeordneten Knotens ist, wird dessen übergeordneter Absatz zurückgegeben. Wenn das Feld bereits entfernt wurde, wird zurückgegebenNull . |
| Unlink() | Führt das Feld unlink aus. |
| Update() | Führt die Feldaktualisierung durch. Wird ausgelöst, wenn das Feld bereits aktualisiert wird. |
| Update(bool) | Führt eine Feldaktualisierung durch. Wird ausgelöst, wenn das Feld bereits aktualisiert wird. |
Bemerkungen
Identifiziert eine Datei, die beim Erstellen eines Inhaltsverzeichnisses, eines Rechtsgrundlagenverzeichnisses oder eines Index mit dem TOC-, TOA- oder INDEX-Feld einbezogen werden soll.
Beispiele
Zeigt die Verwendung des RD-Felds zum Erstellen eines Inhaltsverzeichniseintrags aus Überschriften in anderen Dokumenten an.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Einen Document Builder verwenden, um ein Inhaltsverzeichnis einzufügen,
// und fügen Sie dann einen Eintrag für das Inhaltsverzeichnis auf der folgenden Seite hinzu.
builder.InsertField(FieldType.FieldTOC, true);
builder.InsertBreak(BreakType.PageBreak);
builder.CurrentParagraph.ParagraphFormat.StyleName = "Heading 1";
builder.Writeln("TOC entry from within this document");
// Ein RD-Feld einfügen, das in seiner FileName-Eigenschaft auf ein anderes lokales Dateisystemdokument verweist.
// Das Inhaltsverzeichnis akzeptiert jetzt auch alle Überschriften aus dem referenzierten Dokument als Einträge für seine Tabelle.
FieldRD field = (FieldRD)builder.InsertField(FieldType.FieldRefDoc, true);
field.FileName = ArtifactsDir + "ReferencedDocument.docx";
Assert.AreEqual($" RD {ArtifactsDir.Replace(@"\",@"\\")}ReferencedDocument.docx", field.GetFieldCode());
// Erstellen Sie das Dokument, auf das das RD-Feld verweist, und fügen Sie eine Überschrift ein.
// Diese Überschrift wird als Eintrag im TOC-Feld in unserem ersten Dokument angezeigt.
Document referencedDoc = new Document();
DocumentBuilder refDocBuilder = new DocumentBuilder(referencedDoc);
refDocBuilder.CurrentParagraph.ParagraphFormat.StyleName = "Heading 1";
refDocBuilder.Writeln("TOC entry from referenced document");
referencedDoc.Save(ArtifactsDir + "ReferencedDocument.docx");
doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.RD.docx");
Siehe auch
- class Field
- namensraum Aspose.Words.Fields
- Montage Aspose.Words
