Aspose::Words::Fields::FieldCitation class
Contents
[
Hide
]FieldCitation class
Implements the CITATION field. To learn more, visit the Working with Fields documentation article.
class FieldCitation : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider
Methods
| Method | Description |
|---|---|
| get_AnotherSourceTag() | Gets a value that matches the Tag element’s value of another source to be included in the citation. |
| 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_FormatLanguageId() | Gets the language ID that is used in conjunction with the specified bibliographic style to format the citation in the document. |
| get_IsDirty() | Gets whether the current result of the field is no longer correct (stale) due to other modifications made to 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_PageNumber() | Gets a page number associated with the citation. |
| get_Prefix() | Gets a prefix that is prepended to the citation. |
| 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_SourceTag() | Gets a value that matches the Tag element’s value of the source to insert. |
| get_Start() const | Gets the node that represents the start of the field. |
| get_Suffix() | Gets a suffix that is appended to the citation. |
| get_SuppressAuthor() | Gets whether the author information is suppressed from the citation. |
| get_SuppressTitle() | Gets whether the title information is suppressed from the citation. |
| get_SuppressYear() | Gets whether the year information is suppressed from the citation. |
| virtual get_Type() const | Gets the Microsoft Word field type. |
| get_VolumeNumber() | Gets a volume number associated with the citation. |
| 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_AnotherSourceTag(const System::String&) | Sets a value that matches the Tag element’s value of another source to be included in the citation. |
| set_FormatLanguageId(const System::String&) | Sets the language ID that is used in conjunction with the specified bibliographic style to format the citation in the document. |
| set_IsDirty(bool) | Sets whether the current result of the field is no longer correct (stale) due to other modifications made to 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_PageNumber(const System::String&) | Sets a page number associated with the citation. |
| set_Prefix(const System::String&) | Sets a prefix that is prepended to the citation. |
| set_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
| set_SourceTag(const System::String&) | Sets a value that matches the Tag element’s value of the source to insert. |
| set_Suffix(const System::String&) | Sets a suffix that is appended to the citation. |
| set_SuppressAuthor(bool) | Sets whether the author information is suppressed from the citation. |
| set_SuppressTitle(bool) | Sets whether the title information is suppressed from the citation. |
| set_SuppressYear(bool) | Sets whether the year information is suppressed from the citation. |
| set_VolumeNumber(const System::String&) | Sets a volume number associated with the citation. |
| 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++