FieldCitation
Overview
FieldCitation is a class in Aspose.Words FOSS for Java.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the CITATION field.
Edition status of its 57 listed members (a property and its accessor methods are listed separately, overloads once): 57 not yet exercised by a verified example.
This class declares 40 methods for FieldCitation objects in Java programs.
Available methods include: getAnotherSourceTag, getDisplayResult, getEnd, getFieldCode, getFormat, getFormatLanguageId, getLocaleId, getPageNumber, getPrefix, getResult, getSeparator, getSourceTag, and 24 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: anotherSourceTag, dirty, displayResult, end, fieldCode, format, and 15 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
sourceTag | String | Read/Write | Gets or sets a value that matches the Tag element’s value of the source to insert. |
formatLanguageId | String | Read/Write | Gets or sets the language ID that is used in conjunction with the specified bibliographic style to format the citation in the document. |
prefix | String | Read/Write | Gets or sets a prefix that is prepended to the citation. |
suffix | String | Read/Write | Gets or sets a suffix that is appended to the citation. |
suppressAuthor | boolean | Read/Write | Gets or sets whether the author information is suppressed from the citation. |
suppressTitle | boolean | Read/Write | Gets or sets whether the title information is suppressed from the citation. |
suppressYear | boolean | Read/Write | Gets or sets whether the year information is suppressed from the citation. |
pageNumber | String | Read/Write | Gets or sets a page number associated with the citation. |
volumeNumber | String | Read/Write | Gets or sets a volume number associated with the citation. |
anotherSourceTag | String | Read/Write | Gets or sets a value that matches the Tag element’s value of another source to be included in the citation. |
fieldCode | String | Read | Returns text between field start and field separator (or field end if there is no separator). |
start | FieldStart | Read | Gets the node that represents the start of the field. |
separator | FieldSeparator | Read | Gets the node that represents the field separator. |
end | FieldEnd | Read | Gets the node that represents the field end. |
type | int | Read | Gets the type. |
result | String | Read/Write | Gets or sets text that is between the field separator and field end. |
displayResult | String | Read | Gets the text that represents the displayed field result. |
locked | boolean | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
dirty | boolean | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
format | FieldFormat | Read | Gets a FieldFormat object that provides typed access to field’s formatting. |
localeId | int | Read/Write | Gets or sets the LCID of the field. |
Methods
| Signature | Description |
|---|---|
getSourceTag() → String | Gets or sets a value that matches the Tag element’s value of the source to insert. |
setSourceTag(value: String) | Sets the source tag value. |
getFormatLanguageId() → String | Gets or sets the language ID that is used in conjunction with the specified bibliographic style to format the citation in the document. |
setFormatLanguageId(value: String) | Sets the format language id value. |
getPrefix() → String | Gets or sets a prefix that is prepended to the citation. |
setPrefix(value: String) | Sets the prefix value. |
getSuffix() → String | Gets or sets a suffix that is appended to the citation. |
setSuffix(value: String) | Sets the suffix value. |
getSuppressAuthor() → boolean | Gets or sets whether the author information is suppressed from the citation. |
setSuppressAuthor(value: boolean) | Sets the suppress author value. |
getSuppressTitle() → boolean | Gets or sets whether the title information is suppressed from the citation. |
setSuppressTitle(value: boolean) | Sets the suppress title value. |
getSuppressYear() → boolean | Gets or sets whether the year information is suppressed from the citation. |
setSuppressYear(value: boolean) | Sets the suppress year value. |
getPageNumber() → String | Gets or sets a page number associated with the citation. |
setPageNumber(value: String) | Sets the page number value. |
getVolumeNumber() → String | Gets or sets a volume number associated with the citation. |
setVolumeNumber(value: String) | Sets the volume number value. |
getAnotherSourceTag() → String | Gets or sets a value that matches the Tag element’s value of another source to be included in the citation. |
setAnotherSourceTag(value: String) | Sets the another source tag value. |
getFieldCode() → String | Returns text between field start and field separator (or field end if there is no separator). |
getFieldCode(includeChildFieldCodes: boolean) → String | Returns text between field start and field separator (or field end if there is no separator). |
remove() → Node | Removes the field from the document. |
update() | Performs the field update. |
update(ignoreMergeFormat: boolean) | Performs a field update. |
unlink() → boolean | Performs the field unlink. |
getStart() → FieldStart | Gets the node that represents the start of the field. |
getSeparator() → FieldSeparator | Gets the node that represents the field separator. |
getEnd() → FieldEnd | Gets the node that represents the field end. |
getType() → int | Returns the type. |
getResult() → String | Gets or sets text that is between the field separator and field end. |
setResult(value: String) | Sets the result value. |
getDisplayResult() → String | Gets the text that represents the displayed field result. |
isLocked() → boolean | Gets or sets whether the field is locked (should not recalculate its result). |
isLocked(value: boolean) | Calls isLocked(value) on this FieldCitation instance. |
isDirty() → boolean | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
isDirty(value: boolean) | Calls isDirty(value) on this FieldCitation instance. |
getFormat() → FieldFormat | Gets a FieldFormat object that provides typed access to field’s formatting. |
getLocaleId() → int | Gets or sets the LCID of the field. |
setLocaleId(value: int) | Sets the locale id value. |