Aspose::Words::Fields::FieldLink class
Contents
[
Hide
]FieldLink class
Implements the LINK field. To learn more, visit the Working with Fields documentation article.
class FieldLink : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider
Methods
| Method | Description |
|---|---|
| get_AutoUpdate() | Gets whether to update this field automatically. |
| get_DisplayResult() | Gets the text that represents the displayed field result. |
| get_End() const | Gets the node that represents the field end. |
| get_FieldEnd() const | Gets the node that represents the field end. |
| get_FieldStart() const | Gets the node that represents the start of the field. |
| get_Format() | Gets a FieldFormat object that provides typed access to field’s formatting. |
| get_FormatUpdateType() | Gets a way the linked object updates its formatting. |
| get_InsertAsBitmap() | Gets whether to insert the linked object as a bitmap. |
| get_InsertAsHtml() | Gets whether to insert the linked object as HTML format text. |
| get_InsertAsPicture() | Gets whether to insert the linked object as a picture. |
| get_InsertAsRtf() | Gets whether to insert the linked object in rich-text format (RTF). |
| get_InsertAsText() | Gets whether to insert the linked object in text-only format. |
| get_InsertAsUnicode() | Gets whether to insert the linked object as Unicode text. |
| get_IsDirty() | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| get_IsLinked() | Gets whether to reduce the file size by not storing graphics data with the document. |
| get_IsLocked() | Gets or sets whether the field is locked (should not recalculate its result). |
| get_LocaleId() | Gets or sets the LCID of the field. |
| get_ProgId() | Gets the application type of the link information. |
| get_Result() | Gets or sets text that is between the field separator and field end. |
| get_Separator() | Gets the node that represents the field separator. Can be null. |
| get_SourceFullName() | Gets the name and location of the source file. |
| get_SourceItem() | Gets the portion of the source file that’s being linked. |
| get_Start() const | Gets the node that represents the start of the field. |
| virtual get_Type() const | Gets the Microsoft Word field type. |
| 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. |
| GetFieldCode(bool) | Returns text between field start and field separator (or field end if there is no separator). |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| 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. |
| set_AutoUpdate(bool) | Sets whether to update this field automatically. |
| set_FormatUpdateType(const System::String&) | Sets a way the linked object updates its formatting. |
| set_InsertAsBitmap(bool) | Sets whether to insert the linked object as a bitmap. |
| set_InsertAsHtml(bool) | Sets whether to insert the linked object as HTML format text. |
| set_InsertAsPicture(bool) | Sets whether to insert the linked object as a picture. |
| set_InsertAsRtf(bool) | Sets whether to insert the linked object in rich-text format (RTF). |
| set_InsertAsText(bool) | Sets whether to insert the linked object in text-only format. |
| set_InsertAsUnicode(bool) | Sets whether to insert the linked object as Unicode text. |
| set_IsDirty(bool) | Setter for Aspose::Words::Fields::Field::get_IsDirty. |
| set_IsLinked(bool) | Sets whether to reduce the file size by not storing graphics data with the document. |
| set_IsLocked(bool) | Setter for Aspose::Words::Fields::Field::get_IsLocked. |
| set_LocaleId(int32_t) | Setter for Aspose::Words::Fields::Field::get_LocaleId. |
| set_ProgId(const System::String&) | Sets the application type of the link information. |
| set_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
| set_SourceFullName(const System::String&) | Sets the name and location of the source file. |
| set_SourceItem(const System::String&) | Sets the portion of the source file that’s being linked. |
| static Type() | |
| Unlink() | Performs the field unlink. |
| Update() | Performs the field update. Throws if the field is being updated already. |
| Update(bool) | Performs a field update. Throws if the field is being updated already. |
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++