java.lang.ObjectField
com.aspose.words.FieldCitation
public class FieldCitation
Constructor Summary |
---|
FieldCitation()
|
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getAnotherSourceTag() | |
void | setAnotherSourceTag(java.lang.String value) | |
Gets or sets a value that mathes the Tag element's value of another source to be included in the citation. | ||
FieldEnd | getEnd() | → inherited from Field |
Gets the node that represents the field end. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
java.lang.String | getFormatLanguageId() | |
void | setFormatLanguageId(java.lang.String value) | |
Gets or sets the language ID that is used in conjunction with the specified bibliographic style to format the citation in the document. | ||
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
int | getLocaleId() | → inherited from Field |
void | setLocaleId(int value) | |
Gets or sets the LCID of the field. | ||
java.lang.String | getPageNumber() | |
void | setPageNumber(java.lang.String value) | |
Gets or sets a page number associated with the citation. | ||
java.lang.String | getPrefix() | |
void | setPrefix(java.lang.String value) | |
Gets or sets a prefix that is prepended to the citation. | ||
java.lang.String | getResult() | → inherited from Field |
void | setResult(java.lang.String value) | |
Gets or sets text that is between the field separator and field end. | ||
FieldSeparator | getSeparator() | → inherited from Field |
Gets the node that represents the field separator. Can be null. | ||
java.lang.String | getSourceTag() | |
void | setSourceTag(java.lang.String value) | |
Gets or sets a value that mathes the Tag element's value of the source to insert. | ||
FieldStart | getStart() | → inherited from Field |
Gets the node that represents the start of the field. | ||
java.lang.String | getSuffix() | |
void | setSuffix(java.lang.String value) | |
Gets or sets a suffix that is appended to the citation. | ||
boolean | getSuppressAuthor() | |
void | setSuppressAuthor(boolean value) | |
Gets or sets whether the author information is suppressed from the citation. | ||
boolean | getSuppressTitle() | |
void | setSuppressTitle(boolean value) | |
Gets or sets whether the title information is suppressed from the citation. | ||
boolean | getSuppressYear() | |
void | setSuppressYear(boolean value) | |
Gets or sets whether the year information is suppressed from the citation. | ||
int | getType() | → inherited from Field |
Gets the Microsoft Word field type. The value of the property is FieldType integer constant. | ||
java.lang.String | getVolumeNumber() | |
void | setVolumeNumber(java.lang.String value) | |
Gets or sets a volume number associated with the citation. |
Method Summary | ||
---|---|---|
java.lang.String | getFieldCode() | → inherited from Field |
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. | ||
java.lang.String | getFieldCode(boolean includeChildFieldCodes) | → inherited from Field |
Returns text between field start and field separator (or field end if there is no separator). | ||
aspose.obfuscated.type | getSwitchType(java.lang.String switchName) | |
Reserved for internal use. | ||
Aspose.Words.Node | remove() | → inherited from Field |
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. | ||
boolean | unlink() | → inherited from Field |
Performs the field unlink. | ||
void | update() | → inherited from Field |
Performs the field update. Throws if the field is being updated already. | ||
void | update(boolean ignoreMergeFormat) | → inherited from Field |
Performs a field update. Throws if the field is being updated already. |
Constructor Detail |
---|
public FieldCitation()
Property Getters/Setters Detail |
---|
getAnotherSourceTag/setAnotherSourceTag | |
public java.lang.String getAnotherSourceTag() / public void setAnotherSourceTag(java.lang.String value) |
getEnd | → inherited from Field |
public FieldEnd getEnd() |
getFormat | → inherited from Field |
public FieldFormat getFormat() |
getFormatLanguageId/setFormatLanguageId | |
public java.lang.String getFormatLanguageId() / public void setFormatLanguageId(java.lang.String value) |
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value) |
getPageNumber/setPageNumber | |
public java.lang.String getPageNumber() / public void setPageNumber(java.lang.String value) |
getPrefix/setPrefix | |
public java.lang.String getPrefix() / public void setPrefix(java.lang.String value) |
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
getSeparator | → inherited from Field |
public FieldSeparator getSeparator() |
getSourceTag/setSourceTag | |
public java.lang.String getSourceTag() / public void setSourceTag(java.lang.String value) |
getStart | → inherited from Field |
public FieldStart getStart() |
getSuffix/setSuffix | |
public java.lang.String getSuffix() / public void setSuffix(java.lang.String value) |
getSuppressAuthor/setSuppressAuthor | |
public boolean getSuppressAuthor() / public void setSuppressAuthor(boolean value) |
getSuppressTitle/setSuppressTitle | |
public boolean getSuppressTitle() / public void setSuppressTitle(boolean value) |
getSuppressYear/setSuppressYear | |
public boolean getSuppressYear() / public void setSuppressYear(boolean value) |
getType | → inherited from Field |
public int getType() |
getVolumeNumber/setVolumeNumber | |
public java.lang.String getVolumeNumber() / public void setVolumeNumber(java.lang.String value) |
Method Detail |
---|
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() |
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode(boolean includeChildFieldCodes) |
includeChildFieldCodes
- True
if child field codes should be included.
getSwitchType | |
public aspose.obfuscated.type getSwitchType(java.lang.String switchName) |
remove | → inherited from Field |
public Aspose.Words.Node remove() throws java.lang.Exception |
unlink | → inherited from Field |
public boolean unlink() throws java.lang.Exception |
Replaces the field with its most recent result.
Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.
True
if the field has been unlinked, otherwise false
.
update | → inherited from Field |
public void update() throws java.lang.Exception |
update | → inherited from Field |
public void update(boolean ignoreMergeFormat) throws java.lang.Exception |
ignoreMergeFormat
-
If true
then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.