ImageFieldMergingArgs

Наследование: java.lang.Object, com.aspose.words.FieldMergingArgsBase

public class ImageFieldMergingArgs extends FieldMergingArgsBase

Предоставляет данные дляIFieldMergingCallback.imageFieldMerging(com.aspose.words.ImageFieldMergingArgs) мероприятие.

Чтобы узнать больше, посетитеMail Merge and Reporting документальная статья.

Это событие происходит во время слияния, когда в документе встречается поле слияния изображения. Вы можете отреагировать на это событие, чтобы вернуть имя файла, поток или объект java.awt.image.BufferedImage механизму слияния, чтобы он был вставлен в документ.

Доступны три свойстваgetImageFileName() / setImageFileName(java.lang.String), P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageStream а такжеgetImage() / setImage(java.awt.image.BufferedImage) чтобы указать, откуда должно быть взято изображение. Установите только одно из этих свойств.

Чтобы вставить поле слияния с изображением в документ Word, выберите команду «Вставить/Поле», затем выберите MergeField и введите Image:MyFieldName.

Методы

МетодОписание
equals(Object arg0)
getClass()
getDocument()ВозвращаетgetDocument() объект, для которого выполняется слияние.
getDocumentFieldName()Получает имя поля слияния, указанное в документе.
getField()Получает объект, представляющий текущее поле слияния.
getFieldName()Получает имя поля слияния в источнике данных.
getFieldValue()Получает значение поля из источника данных.
getImage()Указывает изображение, которое механизм слияния должен вставить в документ.
getImageFileName()Задает имя файла изображения, которое механизм слияния должен вставить в документ.
getImageHeight()Задает высоту изображения для вставки в документ.
getImageStream()
getImageWidth()Указывает ширину изображения для вставки изображения в документ.
getRecordIndex()Получает отсчитываемый от нуля индекс объединяемой записи.
getShape()Указывает форму, которую механизм слияния должен вставить в документ.
getTableName()Получает имя таблицы данных для текущей операции слияния или пустую строку, если имя недоступно.
hashCode()
notify()
notifyAll()
setFieldValue(Object value)Задает значение поля из источника данных.
setImage(BufferedImage value)Указывает изображение, которое механизм слияния должен вставить в документ.
setImageFileName(String value)Задает имя файла изображения, которое механизм слияния должен вставить в документ.
setImageHeight(MergeFieldImageDimension value)Задает высоту изображения для вставки в документ.
setImageStream(InputStream value)
setImageWidth(MergeFieldImageDimension value)Указывает ширину изображения для вставки изображения в документ.
setShape(Shape value)Указывает форму, которую механизм слияния должен вставить в документ.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

ПараметрТипОписание
arg0java.lang.Object

Возвращает: логический

getClass()

public final native Class<?> getClass()

Возвращает: java.lang.Класс

getDocument()

public Document getDocument()

ВозвращаетgetDocument() объект, для которого выполняется слияние.

Возвращает: Document -getDocument() объект, для которого выполняется слияние.

getDocumentFieldName()

public String getDocumentFieldName()

Получает имя поля слияния, указанное в документе.

Если у вас есть сопоставление имени поля документа с другим именем поля источника данных, то это исходное имя поля, указанное в документе.

Если вы указали в документе префикс имени поля, например «Image:MyFieldName», тоDocumentFieldName возвращает имя поля без префикса, то есть “MyFieldName”.

Возвращает: java.lang.String — имя поля слияния, указанное в документе.

getField()

public FieldMergeField getField()

Получает объект, представляющий текущее поле слияния.

Возвращает: FieldMergeField - Объект, представляющий текущее поле слияния.

getFieldName()

public String getFieldName()

Получает имя поля слияния в источнике данных.

Если у вас есть сопоставление имени поля документа с другим именем поля источника данных, то это имя сопоставленного поля.

Если вы указали в документе префикс имени поля, например «Image:MyFieldName», тоFieldName возвращает имя поля без префикса, то есть “MyFieldName”.

Возвращает: java.lang.String — имя поля слияния в источнике данных.

getFieldValue()

public Object getFieldValue()

Получает значение поля из источника данных. Это свойство содержит значение, которое только что было выбрано из вашего источника данных для этого поля механизмом слияния. Вы также можете заменить значение, установив свойство.

Возвращает: java.lang.Object — значение поля из источника данных.

getImage()

public BufferedImage getImage()

Указывает изображение, которое механизм слияния должен вставить в документ.

Возвращает: java.awt.image.BufferedImage — соответствующее значение java.awt.image.BufferedImage.

getImageFileName()

public String getImageFileName()

Задает имя файла изображения, которое механизм слияния должен вставить в документ.

Возвращает: java.lang.String — имя файла изображения, которое механизм слияния должен вставить в документ.

getImageHeight()

public MergeFieldImageDimension getImageHeight()

Задает высоту изображения для вставки в документ.

Значение этого свойства исходно исходит из соответствующего кода MERGEFIELD, содержащегося в шаблоне документа. Чтобы переопределить начальное значение, вы должны назначить экземплярMergeFieldImageDimension класса к этому свойству или установить свойства для экземпляраMergeFieldImageDimension класс, возвращаемый этим свойством.

Чтобы указать, что исходное значение высоты изображения должно быть применено, вы должны назначитьnull значение этого свойства или установитеMergeFieldImageDimension.getValue() / MergeFieldImageDimension.setValue(double) свойство для экземпляраMergeFieldImageDimensionкласс, возвращаемый этим свойством, к отрицательному значению.

Возвращает: MergeFieldImageDimension - соответствующийMergeFieldImageDimension ценность.

getImageStream()

public InputStream getImageStream()

Возвращает: java.io.InputStream

getImageWidth()

public MergeFieldImageDimension getImageWidth()

Указывает ширину изображения для вставки изображения в документ.

Значение этого свойства исходно исходит из соответствующего кода MERGEFIELD, содержащегося в шаблоне документа. Чтобы переопределить начальное значение, вы должны назначить экземплярMergeFieldImageDimension класса к этому свойству или установить свойства для экземпляраMergeFieldImageDimension класс, возвращаемый этим свойством.

Чтобы указать, что исходное значение ширины изображения должно быть применено, вы должны назначитьnull значение этого свойства или установитеMergeFieldImageDimension.getValue() / MergeFieldImageDimension.setValue(double) свойство для экземпляраMergeFieldImageDimensionкласс, возвращаемый этим свойством, к отрицательному значению.

Возвращает: MergeFieldImageDimension - соответствующийMergeFieldImageDimension ценность.

getRecordIndex()

public int getRecordIndex()

Получает отсчитываемый от нуля индекс объединяемой записи.

Возвращает: int — индекс объединяемой записи с отсчетом от нуля.

getShape()

public Shape getShape()

Указывает форму, которую механизм слияния должен вставить в документ.

Когда это свойство указано, механизм слияния игнорирует все другие свойства, такие какgetImageFileName() / setImageFileName(java.lang.String) или жеP:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageStream и просто вставляет фигуру в документ.

Используйте это свойство, чтобы полностью контролировать процесс слияния поля слияния изображений. Например, вы можете указатьShapeBase.getWrapType() / ShapeBase.setWrapType(int) или любое другое свойство формы для точной настройки результирующего узла. Однако обратите внимание, что вы несете ответственность за предоставление содержимого формы.

Возвращает: Shape - соответствующийShape ценность.

getTableName()

public String getTableName()

Получает имя таблицы данных для текущей операции слияния или пустую строку, если имя недоступно.

Возвращает: java.lang.String — имя таблицы данных для текущей операции слияния или пустая строка, если имя недоступно.

hashCode()

public native int hashCode()

Возвращает: инт

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setFieldValue(Object value)

public void setFieldValue(Object value)

Задает значение поля из источника данных. Это свойство содержит значение, которое только что было выбрано из вашего источника данных для этого поля механизмом слияния. Вы также можете заменить значение, установив свойство.

Параметры:

ПараметрТипОписание
valuejava.lang.ObjectЗначение поля из источника данных.

setImage(BufferedImage value)

public void setImage(BufferedImage value)

Указывает изображение, которое механизм слияния должен вставить в документ.

Параметры:

ПараметрТипОписание
valuejava.awt.image.BufferedImageСоответствующее значение java.awt.image.BufferedImage.

setImageFileName(String value)

public void setImageFileName(String value)

Задает имя файла изображения, которое механизм слияния должен вставить в документ.

Параметры:

ПараметрТипОписание
valuejava.lang.StringИмя файла изображения, которое механизм слияния должен вставить в документ.

setImageHeight(MergeFieldImageDimension value)

public void setImageHeight(MergeFieldImageDimension value)

Задает высоту изображения для вставки в документ.

Значение этого свойства исходно исходит из соответствующего кода MERGEFIELD, содержащегося в шаблоне документа. Чтобы переопределить начальное значение, вы должны назначить экземплярMergeFieldImageDimension класса к этому свойству или установить свойства для экземпляраMergeFieldImageDimension класс, возвращаемый этим свойством.

Чтобы указать, что исходное значение высоты изображения должно быть применено, вы должны назначитьnull значение этого свойства или установитеMergeFieldImageDimension.getValue() / MergeFieldImageDimension.setValue(double) свойство для экземпляраMergeFieldImageDimensionкласс, возвращаемый этим свойством, к отрицательному значению.

Параметры:

ПараметрТипОписание
valueMergeFieldImageDimensionСоответствующийMergeFieldImageDimension ценность.

setImageStream(InputStream value)

public void setImageStream(InputStream value)

Параметры:

ПараметрТипОписание
valuejava.io.InputStream

setImageWidth(MergeFieldImageDimension value)

public void setImageWidth(MergeFieldImageDimension value)

Указывает ширину изображения для вставки изображения в документ.

Значение этого свойства исходно исходит из соответствующего кода MERGEFIELD, содержащегося в шаблоне документа. Чтобы переопределить начальное значение, вы должны назначить экземплярMergeFieldImageDimension класса к этому свойству или установить свойства для экземпляраMergeFieldImageDimension класс, возвращаемый этим свойством.

Чтобы указать, что исходное значение ширины изображения должно быть применено, вы должны назначитьnull значение этого свойства или установитеMergeFieldImageDimension.getValue() / MergeFieldImageDimension.setValue(double) свойство для экземпляраMergeFieldImageDimensionкласс, возвращаемый этим свойством, к отрицательному значению.

Параметры:

ПараметрТипОписание
valueMergeFieldImageDimensionСоответствующийMergeFieldImageDimension ценность.

setShape(Shape value)

public void setShape(Shape value)

Указывает форму, которую механизм слияния должен вставить в документ.

Когда это свойство указано, механизм слияния игнорирует все другие свойства, такие какgetImageFileName() / setImageFileName(java.lang.String) или жеP:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageStream и просто вставляет фигуру в документ.

Используйте это свойство, чтобы полностью контролировать процесс слияния поля слияния изображений. Например, вы можете указатьShapeBase.getWrapType() / ShapeBase.setWrapType(int) или любое другое свойство формы для точной настройки результирующего узла. Однако обратите внимание, что вы несете ответственность за предоставление содержимого формы.

Параметры:

ПараметрТипОписание
valueShapeСоответствующийShape ценность.

toString()

public String toString()

Возвращает: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

ПараметрТипОписание
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

ПараметрТипОписание
arg0long
arg1int