FieldIncludePicture

FieldIncludePicture

Overview

FieldIncludePicture is a class in Aspose.Words FOSS for Java. Inherits from: Field, IFieldCodeTokenInfoProvider, IFieldIncludePictureCode.

Implements the INCLUDEPICTURE field.

Edition status of its 41 listed members (a property and its accessor methods are listed separately, overloads once): 41 not yet exercised by a verified example.

This class declares 30 methods for FieldIncludePicture objects in Java programs. Available methods include: getDisplayResult, getEnd, getFieldCode, getFormat, getGraphicFilter, getLocaleId, getResizeHorizontally, getResizeVertically, getResult, getSeparator, getSourceFullName, getStart, and 13 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: dirty, displayResult, end, fieldCode, format, graphicFilter, and 10 more.

Properties

NameTypeAccessDescription
sourceFullNameStringRead/WriteGets or sets the location of the picture using an IRI.
graphicFilterStringRead/WriteGets or sets the name of the filter for the format of the graphic that is to be inserted.
linkedbooleanRead/WriteGets or sets whether to reduce the file size by not storing graphics data with the document.
resizeHorizontallybooleanRead/WriteGets or sets whether to resize the picture horizontally from the source.
resizeVerticallybooleanRead/WriteGets or sets whether to resize the picture vertically from the source.
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
getSourceFullName() → StringGets or sets the location of the picture using an IRI.
setSourceFullName(value: String)Sets the source full name value.
getGraphicFilter() → StringGets or sets the name of the filter for the format of the graphic that is to be inserted.
setGraphicFilter(value: String)Sets the graphic filter value.
isLinked() → booleanGets or sets whether to reduce the file size by not storing graphics data with the document.
isLinked(value: boolean)Calls isLinked(value) on this FieldIncludePicture instance.
getResizeHorizontally() → booleanGets or sets whether to resize the picture horizontally from the source.
setResizeHorizontally(value: boolean)Sets the resize horizontally value.
getResizeVertically() → booleanGets or sets whether to resize the picture vertically from the source.
setResizeVertically(value: boolean)Sets the resize vertically 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 FieldIncludePicture 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 FieldIncludePicture 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