FieldIncludePicture

FieldIncludePicture

Overview

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

Implements the INCLUDEPICTURE field.

This class provides 4 methods for working with FieldIncludePicture objects in .NET programs. Available methods include: GetFieldCode, Remove, Unlink, Update. All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package. Properties: DisplayResult, End, Format, GraphicFilter, IsDirty, IsLinked, and 9 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.
IsLinkedboolRead/WriteGets or sets whether to reduce the file size by not storing graphics data with the document.
ResizeHorizontallyboolRead/WriteGets or sets whether to resize the picture horizontally from the source.
ResizeVerticallyboolRead/WriteGets or sets whether to resize the picture vertically from the source.
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.
TypeFieldTypeReadGets the Microsoft Word field type.
ResultstringRead/WriteGets or sets text that is between the field separator and field end.
DisplayResultstringReadGets the text that represents the displayed field result.
IsLockedboolRead/WriteGets or sets whether the field is locked (should not recalculate its result).
IsDirtyboolRead/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
GetFieldCode()Returns text between field start and field separator (or field end if there is no separator).
Remove()Removes the field from the document.
Update()Performs the field update.
Unlink()Performs the field unlink.

See Also