FieldIncludeText Class |
Namespace: Aspose.Words.Fields
The FieldIncludeText type exposes the following members.
Name | Description | |
---|---|---|
![]() | FieldIncludeText | Initializes a new instance of the FieldIncludeText class |
Name | Description | |
---|---|---|
![]() ![]() | BookmarkName |
Gets or sets the name of the bookmark in the document to include.
|
![]() ![]() | DisplayResult |
Gets the text that represents the displayed field result.
(Inherited from Field.) |
![]() ![]() | Encoding |
Gets or sets the encoding applied to the data within the referenced file.
|
![]() ![]() | End |
Gets the node that represents the field end.
(Inherited from Field.) |
![]() ![]() | Format |
Gets a FieldFormat object that provides typed access to field's formatting.
(Inherited from Field.) |
![]() ![]() | IsDirty |
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
(Inherited from Field.) |
![]() ![]() | IsLocked |
Gets or sets whether the field is locked (should not recalculate its result).
(Inherited from Field.) |
![]() ![]() | LocaleId |
Gets or sets the LCID of the field.
(Inherited from Field.) |
![]() ![]() | LockFields |
Gets or sets whether to prevent fields in the included document from being updated.
|
![]() ![]() | MimeType |
Gets or sets the MIME type of the referenced file.
|
![]() ![]() | NamespaceMappings |
Gets or sets the namespace mappings for XPath queries.
|
![]() ![]() | Result |
Gets or sets text that is between the field separator and field end.
(Inherited from Field.) |
![]() ![]() | Separator |
Gets the node that represents the field separator. Can be null.
(Inherited from Field.) |
![]() ![]() | SourceFullName |
Gets or sets the location of the document using an IRI.
|
![]() ![]() | Start |
Gets the node that represents the start of the field.
(Inherited from Field.) |
![]() ![]() | TextConverter |
Gets or sets the name of the text converter for the format of the included file.
|
![]() ![]() | Type |
Gets the Microsoft Word field type.
(Inherited from Field.) |
![]() ![]() | XPath |
Gets or sets XPath for the desired portion of the XML file.
|
![]() ![]() | XslTransformation |
Gets or sets the location of XSL Transformation to format XML data.
|
Name | Description | |
---|---|---|
![]() | Equals | (Inherited from Object.) |
![]() ![]() | GetFieldCode |
Returns text between field start and field separator (or field end if there is no separator).
Both field code and field result of child fields are included.
(Inherited from Field.) |
![]() ![]() | GetFieldCode(Boolean) |
Returns text between field start and field separator (or field end if there is no separator).
(Inherited from Field.) |
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetType | (Inherited from Object.) |
![]() ![]() | Remove |
Removes the field from the document. Returns a node right after the field. If the field's end is the last child
of its parent node, returns its parent paragraph. If the field is already removed, returns null.
(Inherited from Field.) |
![]() | ToString | (Inherited from Object.) |
![]() ![]() | Unlink |
Performs the field unlink.
(Inherited from Field.) |
![]() ![]() | Update |
Performs the field update. Throws if the field is being updated already.
(Inherited from Field.) |
![]() ![]() | Update(Boolean) |
Performs a field update. Throws if the field is being updated already.
(Inherited from Field.) |
public void FieldIncludeText() { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Use a document builder to insert an include text field and perform an XSL transformation on an XML document FieldIncludeText fieldIncludeText = CreateFieldIncludeText(builder, MyDir + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1"); fieldIncludeText.XslTransformation = MyDir + "CD collection XSL transformation.xsl"; builder.Writeln(); // Use a document builder to insert an include text field and use an XPath to take specific elements fieldIncludeText = CreateFieldIncludeText(builder, MyDir + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1"); fieldIncludeText.NamespaceMappings = "xmlns:n='myNamespace'"; fieldIncludeText.XPath = "/catalog/cd/title"; doc.Save(ArtifactsDir + "Field.INCLUDETEXT.docx"); } /// <summary> /// Use a document builder to insert an INCLUDETEXT field and set its properties. /// </summary> public FieldIncludeText CreateFieldIncludeText(DocumentBuilder builder, string sourceFullName, bool lockFields, string mimeType, string textConverter, string encoding) { FieldIncludeText fieldIncludeText = (FieldIncludeText)builder.InsertField(FieldType.FieldIncludeText, true); fieldIncludeText.SourceFullName = sourceFullName; fieldIncludeText.LockFields = lockFields; fieldIncludeText.MimeType = mimeType; fieldIncludeText.TextConverter = textConverter; fieldIncludeText.Encoding = encoding; return fieldIncludeText; }