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

NameTypeAccessDescription
sourceTagStringRead/WriteGets or sets a value that matches the Tag element’s value of the source to insert.
formatLanguageIdStringRead/WriteGets or sets the language ID that is used in conjunction with the specified bibliographic style to format the citation in the document.
prefixStringRead/WriteGets or sets a prefix that is prepended to the citation.
suffixStringRead/WriteGets or sets a suffix that is appended to the citation.
suppressAuthorbooleanRead/WriteGets or sets whether the author information is suppressed from the citation.
suppressTitlebooleanRead/WriteGets or sets whether the title information is suppressed from the citation.
suppressYearbooleanRead/WriteGets or sets whether the year information is suppressed from the citation.
pageNumberStringRead/WriteGets or sets a page number associated with the citation.
volumeNumberStringRead/WriteGets or sets a volume number associated with the citation.
anotherSourceTagStringRead/WriteGets or sets a value that matches the Tag element’s value of another source to be included in the citation.
fieldCodeStringReadReturns text between field start and field separator (or field end if there is no separator).
startFieldStartReadGets the node that represents the start of the field.
separatorFieldSeparatorReadGets the node that represents the field separator.
endFieldEndReadGets the node that represents the field end.
typeintReadGets the type.
resultStringRead/WriteGets or sets text that is between the field separator and field end.
displayResultStringReadGets the text that represents the displayed field result.
lockedbooleanRead/WriteGets or sets whether the field is locked (should not recalculate its result).
dirtybooleanRead/WriteGets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
formatFieldFormatReadGets a FieldFormat object that provides typed access to field’s formatting.
localeIdintRead/WriteGets or sets the LCID of the field.

Methods

SignatureDescription
getSourceTag() → StringGets 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() → StringGets 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() → StringGets or sets a prefix that is prepended to the citation.
setPrefix(value: String)Sets the prefix value.
getSuffix() → StringGets or sets a suffix that is appended to the citation.
setSuffix(value: String)Sets the suffix value.
getSuppressAuthor() → booleanGets or sets whether the author information is suppressed from the citation.
setSuppressAuthor(value: boolean)Sets the suppress author value.
getSuppressTitle() → booleanGets or sets whether the title information is suppressed from the citation.
setSuppressTitle(value: boolean)Sets the suppress title value.
getSuppressYear() → booleanGets or sets whether the year information is suppressed from the citation.
setSuppressYear(value: boolean)Sets the suppress year value.
getPageNumber() → StringGets or sets a page number associated with the citation.
setPageNumber(value: String)Sets the page number value.
getVolumeNumber() → StringGets or sets a volume number associated with the citation.
setVolumeNumber(value: String)Sets the volume number value.
getAnotherSourceTag() → StringGets 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() → StringReturns text between field start and field separator (or field end if there is no separator).
getFieldCode(includeChildFieldCodes: boolean) → StringReturns text between field start and field separator (or field end if there is no separator).
remove() → NodeRemoves the field from the document.
update()Performs the field update.
update(ignoreMergeFormat: boolean)Performs a field update.
unlink() → booleanPerforms the field unlink.
getStart() → FieldStartGets the node that represents the start of the field.
getSeparator() → FieldSeparatorGets the node that represents the field separator.
getEnd() → FieldEndGets the node that represents the field end.
getType() → intReturns the type.
getResult() → StringGets or sets text that is between the field separator and field end.
setResult(value: String)Sets the result value.
getDisplayResult() → StringGets the text that represents the displayed field result.
isLocked() → booleanGets or sets whether the field is locked (should not recalculate its result).
isLocked(value: boolean)Calls isLocked(value) on this FieldCitation instance.
isDirty() → booleanGets 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() → FieldFormatGets a FieldFormat object that provides typed access to field’s formatting.
getLocaleId() → intGets or sets the LCID of the field.
setLocaleId(value: int)Sets the locale id value.

See Also