ImageSavingArgs

Наследование: java.lang.Object

public class ImageSavingArgs

Предоставляет данные дляIImageSavingCallback.imageSaving(com.aspose.words.ImageSavingArgs) мероприятие.

Чтобы узнать больше, посетитеSave a Document документальная статья.

По умолчанию, когда Aspose.Words сохраняет документ в формате HTML, каждое изображение сохраняется в отдельный файл. Aspose.Words использует имя файла документа и уникальный номер для создания уникального имени файла для каждого изображения, найденного в документе.

ImageSavingArgs позволяет переопределить, как генерируются имена файлов изображений, или полностью обойти сохранение изображений в файлы, предоставив свои собственные потоковые объекты.

Чтобы применить собственную логику для генерации имен файлов изображений, используйтеgetImageFileName() / setImageFileName(java.lang.String), getCurrentShape() а такжеisImageAvailable() характеристики.

Чтобы сохранять изображения в потоки вместо файлов, используйтеP:Aspose.Words.Saving.ImageSavingArgs.ImageStream имущество.

Методы

МетодОписание
equals(Object arg0)
getClass()
getCurrentShape()ПолучаетShapeBase объект, соответствующий фигуре или групповой фигуре, которую нужно сохранить.
getDocument()Получает объект документа, который в данный момент сохраняется.
getImageFileName()Получает имя файла (без пути), в котором будет сохранено изображение.
getImageStream()
getKeepImageStreamOpen()Указывает, должен ли Aspose.Words оставить поток открытым или закрыть его после сохранения изображения.
hashCode()
isImageAvailable()Возвращает true, если текущее изображение доступно для экспорта.
notify()
notifyAll()
setImageFileName(String value)Задает имя файла (без пути), в котором будет сохранено изображение.
setImageStream(OutputStream value)
setKeepImageStreamOpen(boolean value)Указывает, должен ли Aspose.Words оставить поток открытым или закрыть его после сохранения изображения.
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.Класс

getCurrentShape()

public ShapeBase getCurrentShape()

ПолучаетShapeBase объект, соответствующий фигуре или групповой фигуре, которую нужно сохранить.

IImageSavingCallback может быть запущен при сохранении формы или формы группы. Вот почему свойство имеетShapeBase тип. Вы можете проверить, является ли это формой группы, сравниваяShapeBase.getShapeType() сShapeType.GROUP или приведя его к одному из производных классов:Shape или жеGroupShape.

Aspose.Words использует имя файла документа и уникальный номер для создания уникального имени файла для каждого изображения, найденного в документе. Вы можете использоватьgetCurrentShape() свойство для создания «лучшего» имени файла путем изучения свойств формы, таких какImageData.getTitle() / ImageData.setTitle(java.lang.String) (только форма),ImageData.getSourceFullName() / ImageData.setSourceFullName(java.lang.String) (только форма) иShapeBase.getName() / ShapeBase.setName(java.lang.String). Конечно, вы можете создавать имена файлов, используя любые другие свойства или критерии, но обратите внимание, что имена вспомогательных файлов должны быть уникальными в рамках операции экспорта.

Некоторые изображения в документе могут быть недоступны. Чтобы проверить доступность изображения, используйтеisImageAvailable() имущество.

Возвращает: ShapeBase -ShapeBase объект, соответствующий фигуре или групповой фигуре, которую нужно сохранить.

getDocument()

public Document getDocument()

Получает объект документа, который в данный момент сохраняется.

Возвращает: Document - Объект документа, который в данный момент сохраняется.

getImageFileName()

public String getImageFileName()

Получает имя файла (без пути), в котором будет сохранено изображение.

Это свойство позволяет переопределить способ генерации имен файлов изображений во время экспорта в HTML.

Когда событие запускается, это свойство содержит имя файла, созданное Aspose.Words. Вы можете изменить значение этого свойства, чтобы сохранить изображение в другой файл. Обратите внимание, что имена файлов должны быть уникальными.

Aspose.Words автоматически генерирует уникальное имя файла для каждого встроенного изображения при экспорте в формат HTML. Способ генерации имени файла изображения зависит от того, сохраняете ли вы документ в файл или в поток.

При сохранении документа в файл сгенерированное имя файла изображения выглядит так:.![Image 1][]..

При сохранении документа в поток сгенерированное имя файла изображения выглядит так:Aspose.Words..![Image 1][]..

getImageFileName() / setImageFileName(java.lang.String) должен содержать только имя файла без пути. Aspose.Words определяет путь для сохранения и значение атрибута src для записи в HTML по имени файла документа,HtmlSaveOptions.getImagesFolder() / HtmlSaveOptions.setImagesFolder(java.lang.String) а такжеHtmlSaveOptions.getImagesFolderAlias() / HtmlSaveOptions.setImagesFolderAlias(java.lang.String) характеристики.

[Изображение 1]:

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

getImageStream()

public OutputStream getImageStream()

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

getKeepImageStreamOpen()

public boolean getKeepImageStreamOpen()

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

По умолчанию установлено значение false, и Aspose.Words закроет поток, указанный вами вP:Aspose.Words.Saving.ImageSavingArgs.ImageStreamсвойство после записи в него изображения. Укажите значение true, чтобы поток оставался открытым.

P:Aspose.Words.Saving.ImageSavingArgs.ImageStream

Возвращает: boolean - соответствующее логическое значение.

hashCode()

public native int hashCode()

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

isImageAvailable()

public boolean isImageAvailable()

Возвращает true, если текущее изображение доступно для экспорта.

Некоторые изображения в документе могут быть недоступны, например, потому что изображение связано, а ссылка недоступна или не указывает на действительное изображение. В этом случае Aspose.Words экспортирует значок с красным крестом. Это свойство возвращает значение true, если исходное изображение доступно; возвращает false, если исходное изображение недоступно и для сохранения будет предложен значок «нет изображения».

При сохранении фигуры группы или фигуры, не требующей изображения, это свойство всегда имеет значение true .

Возвращает: логический -{ true, если текущее изображение доступно для экспорта.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setImageFileName(String value)

public void setImageFileName(String value)

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

Это свойство позволяет переопределить способ генерации имен файлов изображений во время экспорта в HTML.

Когда событие запускается, это свойство содержит имя файла, созданное Aspose.Words. Вы можете изменить значение этого свойства, чтобы сохранить изображение в другой файл. Обратите внимание, что имена файлов должны быть уникальными.

Aspose.Words автоматически генерирует уникальное имя файла для каждого встроенного изображения при экспорте в формат HTML. Способ генерации имени файла изображения зависит от того, сохраняете ли вы документ в файл или в поток.

При сохранении документа в файл сгенерированное имя файла изображения выглядит так:.![Image 1][]..

При сохранении документа в поток сгенерированное имя файла изображения выглядит так:Aspose.Words..![Image 1][]..

getImageFileName() / setImageFileName(java.lang.String) должен содержать только имя файла без пути. Aspose.Words определяет путь для сохранения и значение атрибута src для записи в HTML по имени файла документа,HtmlSaveOptions.getImagesFolder() / HtmlSaveOptions.setImagesFolder(java.lang.String) а такжеHtmlSaveOptions.getImagesFolderAlias() / HtmlSaveOptions.setImagesFolderAlias(java.lang.String) характеристики.

[Изображение 1]:

Параметры:

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

setImageStream(OutputStream value)

public void setImageStream(OutputStream value)

Параметры:

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

setKeepImageStreamOpen(boolean value)

public void setKeepImageStreamOpen(boolean value)

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

По умолчанию установлено значение false, и Aspose.Words закроет поток, указанный вами вP:Aspose.Words.Saving.ImageSavingArgs.ImageStreamсвойство после записи в него изображения. Укажите значение true, чтобы поток оставался открытым.

P:Aspose.Words.Saving.ImageSavingArgs.ImageStream

Параметры:

ПараметрТипОписание
valuebooleanСоответствующее логическое значение.

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