ChmLoadOptions
Наследование: java.lang.Object, com.aspose.words.LoadOptions
public class ChmLoadOptions extends LoadOptions
Позволяет указать дополнительные параметры при загрузке документа CHM вDocument объект.
Чтобы узнать больше, посетитеSpecify Load Options документальная статья.
Конструкторы
Конструктор | Описание |
---|---|
ChmLoadOptions() | Инициализирует новый экземпляр этого класса со значениями по умолчанию. |
Методы
Метод | Описание |
---|---|
equals(Object arg0) | |
getBaseUri() | Получает строку, которая будет использоваться для преобразования относительных URI, найденных в документе, в абсолютные URI, когда это необходимо. |
getClass() | |
getConvertMetafilesToPng() | Получает, следует ли преобразовывать метафайл (F:Aspose.FileFormat.Wmf или жеF:Aspose.FileFormat.Emf ) изображения вF:Aspose.FileFormat.Png формат изображения. |
getConvertShapeToOfficeMath() | Определяет, следует ли преобразовывать фигуры с помощью EquationXML в объекты Office Math. |
getEncoding() | Получает кодировку, которая будет использоваться для загрузки документа HTML, TXT или CHM, если кодировка не указана внутри документа. |
getFontSettings() | Позволяет указать настройки шрифта документа. |
getLanguagePreferences() | Получает языковые настройки, которые будут использоваться при загрузке документа. |
getLoadFormat() | Задает формат загружаемого документа. |
getMswVersion() | Позволяет указать, что процесс загрузки документа должен соответствовать конкретной версии MS Word. |
getOriginalFileName() | Имя CHM-файла. |
getPassword() | Получает пароль для открытия зашифрованного документа. |
getPreserveIncludePictureField() | Определяет, следует ли сохранять поле INCLUDEPICTURE при чтении форматов Microsoft Word. |
getProgressCallback() | Вызывается во время загрузки документа и принимает данные о ходе загрузки. |
getResourceLoadingCallback() | Позволяет управлять загрузкой внешних ресурсов (изображений, таблиц стилей) при импорте документа из HTML, MHTML. |
getTempFolder() | Позволяет использовать временные файлы при чтении документа. |
getUpdateDirtyFields() | Указывает, следует ли обновлять поля с грязным атрибутом. |
getWarningCallback() | Вызывается во время операции загрузки при обнаружении проблемы, которая может привести к потере точности данных или форматирования. |
hashCode() | |
notify() | |
notifyAll() | |
setBaseUri(String value) | Задает строку, которая будет использоваться для преобразования относительных URI, найденных в документе, в абсолютные URI, когда это необходимо. |
setConvertMetafilesToPng(boolean value) | Устанавливает, следует ли преобразовывать метафайл (F:Aspose.FileFormat.Wmf или жеF:Aspose.FileFormat.Emf ) изображения вF:Aspose.FileFormat.Png формат изображения. |
setConvertShapeToOfficeMath(boolean value) | Устанавливает, следует ли преобразовывать фигуры с EquationXML в объекты Office Math. |
setEncoding(Charset value) | Задает кодировку, которая будет использоваться для загрузки документа HTML, TXT или CHM, если кодировка не указана внутри документа. |
setFontSettings(FontSettings value) | Позволяет указать настройки шрифта документа. |
setLoadFormat(int value) | Задает формат загружаемого документа. |
setMswVersion(int value) | Позволяет указать, что процесс загрузки документа должен соответствовать конкретной версии MS Word. |
setOriginalFileName(String value) | Имя CHM-файла. |
setPassword(String value) | Устанавливает пароль для открытия зашифрованного документа. |
setPreserveIncludePictureField(boolean value) | Устанавливает, сохранять ли поле INCLUDEPICTURE при чтении форматов Microsoft Word. |
setProgressCallback(IDocumentLoadingCallback value) | Вызывается во время загрузки документа и принимает данные о ходе загрузки. |
setResourceLoadingCallback(IResourceLoadingCallback value) | Позволяет управлять загрузкой внешних ресурсов (изображений, таблиц стилей) при импорте документа из HTML, MHTML. |
setTempFolder(String value) | Позволяет использовать временные файлы при чтении документа. |
setUpdateDirtyFields(boolean value) | Указывает, следует ли обновлять поля с грязным атрибутом. |
setWarningCallback(IWarningCallback value) | Вызывается во время операции загрузки при обнаружении проблемы, которая может привести к потере точности данных или форматирования. |
toString() | |
wait() | |
wait(long arg0) | |
wait(long arg0, int arg1) |
ChmLoadOptions()
public ChmLoadOptions()
Инициализирует новый экземпляр этого класса со значениями по умолчанию.
equals(Object arg0)
public boolean equals(Object arg0)
Параметры:
Параметр | Тип | Описание |
---|---|---|
arg0 | java.lang.Object |
Возвращает: логический
getBaseUri()
public String getBaseUri()
Получает строку, которая будет использоваться для преобразования относительных URI, найденных в документе, в абсолютные URI, когда это необходимо. Может быть нулевой или пустой строкой. Значение по умолчанию равно нулю.
Это свойство используется для преобразования относительных URI в абсолютные в следующих случаях:
- При загрузке HTML-документа из потока, когда документ содержит изображения с относительными URI и не имеет базового URI, указанного в элементе BASE HTML.
- При сохранении документа в PDF и других форматах для извлечения изображений, связанных с использованием относительных URI, чтобы изображения можно было сохранить в выходной документ.
Возвращает: java.lang.String — строка, которая будет использоваться для преобразования относительных URI, найденных в документе, в абсолютные URI, когда это необходимо.
getClass()
public final native Class<?> getClass()
Возвращает: java.lang.Класс
getConvertMetafilesToPng()
public boolean getConvertMetafilesToPng()
Получает, следует ли преобразовывать метафайл (F:Aspose.FileFormat.Wmf или жеF:Aspose.FileFormat.Emf ) изображения вF:Aspose.FileFormat.Png формат изображения. Метафайлы (F:Aspose.FileFormat.Wmf или жеF:Aspose.FileFormat.Emf ) представляет собой несжатый формат изображения и иногда требует много оперативной памяти для хранения и обработки документа. Эта опция позволяет преобразовать все изображения метафайла вF:Aspose.FileFormat.Png при загрузке документа. Обратите внимание - преобразование векторной графики в растровую снижает качество изображений.
Возвращает: boolean — конвертировать ли метафайл (F:Aspose.FileFormat.Wmf или жеF:Aspose.FileFormat.Emf ) изображения вF:Aspose.FileFormat.Png формат изображения.
getConvertShapeToOfficeMath()
public boolean getConvertShapeToOfficeMath()
Определяет, следует ли преобразовывать фигуры с помощью EquationXML в объекты Office Math.
Возвращает: boolean — следует ли преобразовывать фигуры с помощью EquationXML в объекты Office Math.
getEncoding()
public Charset getEncoding()
Получает кодировку, которая будет использоваться для загрузки документа HTML, TXT или CHM, если кодировка не указана внутри документа. Может быть нулевым. Значение по умолчанию равно нулю.
Это свойство используется только при загрузке документов HTML, TXT или CHM.
Если кодировка внутри документа не указана и это свойство равно null , то система попытается автоматически определить кодировку.
Возвращает: java.nio.charset.Charset — кодировка, которая будет использоваться для загрузки документа HTML, TXT или CHM, если кодировка не указана внутри документа.
getFontSettings()
public FontSettings getFontSettings()
Позволяет указать настройки шрифта документа.
При загрузке некоторых форматов Aspose.Words может потребовать разрешения шрифтов. Например, при загрузке HTML-документов Aspose.Words может разрешить шрифты для выполнения резервного шрифта.
Если установлено значение null, настройки статического шрифта по умолчаниюFontSettings.getDefaultInstance() будет использован.
Значение по умолчанию равно нулю.
Возвращает: FontSettings - соответствующийFontSettings ценность.
getLanguagePreferences()
public LanguagePreferences getLanguagePreferences()
Получает языковые настройки, которые будут использоваться при загрузке документа.
Возвращает: LanguagePreferences - Языковые настройки, которые будут использоваться при загрузке документа.
getLoadFormat()
public int getLoadFormat()
Задает формат загружаемого документа. По умолчаниюLoadFormat.AUTO.
Рекомендуется указатьLoadFormat.AUTOзначение и позволить Aspose.Words автоматически определить формат файла. Если вы знаете формат документа, который собираетесь загрузить, вы можете явно указать формат, и это немного сократит время загрузки за счет накладных расходов, связанных с автоматическим определением формата. Если вы укажете явный формат загрузки, и он окажется неверным, сработает автоопределение и будет предпринята вторая попытка загрузить файл.
Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изLoadFormat константы.
getMswVersion()
public int getMswVersion()
Позволяет указать, что процесс загрузки документа должен соответствовать конкретной версии MS Word. Значение по умолчаниюMsWordVersion.WORD_2019 Различные версии Word могут немного по-разному обрабатывать некоторые аспекты содержимого и форматирования документа в процессе загрузки, что может привести к незначительным различиям в объектной модели документа.
Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изMsWordVersion константы.
getOriginalFileName()
public String getOriginalFileName()
Имя CHM-файла. Значение по умолчанию равно нулю.
Документы CHM могут содержать ссылки, ссылающиеся на один и тот же документ по имени файла. Aspose.Words поддерживает такие ссылки и обычно используетDocument.getOriginalFileName()чтобы проверить, является ли файл, на который ссылается ссылка, загружаемым файлом. Если документ загружается из потока, его оригинальное имя файла должно быть указано явно через это свойство, так как оно не может быть определено автоматически.
Если документ CHM загружается из файла и для этого свойства указано ненулевое значение, это значение будет иметь приоритет над фактическим именем файла, хранящегося вDocument.getOriginalFileName().
Возвращает: java.lang.String — соответствующее значение java.lang.String.
getPassword()
public String getPassword()
Получает пароль для открытия зашифрованного документа. Может быть нулевой или пустой строкой. Значение по умолчанию равно нулю.
Вам нужно знать пароль, чтобы открыть зашифрованный документ. Если документ не зашифрован, установите для этого параметра значение null или пустую строку.
Возвращает: java.lang.String — пароль для открытия зашифрованного документа.
getPreserveIncludePictureField()
public boolean getPreserveIncludePictureField()
Определяет, следует ли сохранять поле INCLUDEPICTURE при чтении форматов Microsoft Word. Значение по умолчанию неверно.
По умолчанию поле INCLUDEPICTURE преобразуется в объект формы. Вы можете переопределить это, если вам нужно сохранить поле, например, если вы хотите обновить его программно. Обратите внимание, однако, что этот подход не является общим для Aspose.Words. Используйте его на свой страх и риск.
Одним из возможных вариантов использования может быть использование MERGEFIELD в качестве дочернего поля для динамического изменения исходного пути изображения. В этом случае вам нужно сохранить INCLUDEPICTURE в модели.
Возвращает: boolean — сохранять ли поле INCLUDEPICTURE при чтении форматов Microsoft Word.
getProgressCallback()
public IDocumentLoadingCallback getProgressCallback()
Вызывается во время загрузки документа и принимает данные о ходе загрузки.
LoadFormat.DOCX, LoadFormat.FLAT_OPC, LoadFormat.DOCM, LoadFormat.DOTM, LoadFormat.DOTX, LoadFormat.MARKDOWN, LoadFormat.RTF, LoadFormat.WORD_ML, LoadFormat.DOC, LoadFormat.DOT, LoadFormat.ODT, LoadFormat.OTT поддерживаемые форматы.
Возвращает: IDocumentLoadingCallback - соответствующийIDocumentLoadingCallback ценность.
getResourceLoadingCallback()
public IResourceLoadingCallback getResourceLoadingCallback()
Позволяет управлять загрузкой внешних ресурсов (изображений, таблиц стилей) при импорте документа из HTML, MHTML.
Возвращает: IResourceLoadingCallback - соответствующийIResourceLoadingCallback ценность.
getTempFolder()
public String getTempFolder()
Позволяет использовать временные файлы при чтении документа. По умолчанию это свойство имеет значение null, и временные файлы не используются.
Папка должна существовать и быть доступной для записи, иначе будет выдано исключение.
Aspose.Words автоматически удаляет все временные файлы после завершения чтения.
Возвращает: java.lang.String — соответствующее значение java.lang.String.
getUpdateDirtyFields()
public boolean getUpdateDirtyFields()
Указывает, следует ли обновлять поля с грязным атрибутом.
Возвращает: boolean - соответствующее логическое значение.
getWarningCallback()
public IWarningCallback getWarningCallback()
Вызывается во время операции загрузки при обнаружении проблемы, которая может привести к потере точности данных или форматирования.
Возвращает: IWarningCallback - соответствующийIWarningCallback ценность.
hashCode()
public native int hashCode()
Возвращает: инт
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setBaseUri(String value)
public void setBaseUri(String value)
Задает строку, которая будет использоваться для преобразования относительных URI, найденных в документе, в абсолютные URI, когда это необходимо. Может быть нулевой или пустой строкой. Значение по умолчанию равно нулю.
Это свойство используется для преобразования относительных URI в абсолютные в следующих случаях:
- При загрузке HTML-документа из потока, когда документ содержит изображения с относительными URI и не имеет базового URI, указанного в элементе BASE HTML.
- При сохранении документа в PDF и других форматах для извлечения изображений, связанных с использованием относительных URI, чтобы изображения можно было сохранить в выходной документ.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.lang.String | Строка, которая будет использоваться для преобразования относительных URI, найденных в документе, в абсолютные URI, когда это необходимо. |
setConvertMetafilesToPng(boolean value)
public void setConvertMetafilesToPng(boolean value)
Устанавливает, следует ли преобразовывать метафайл (F:Aspose.FileFormat.Wmf или жеF:Aspose.FileFormat.Emf ) изображения вF:Aspose.FileFormat.Png формат изображения. Метафайлы (F:Aspose.FileFormat.Wmf или жеF:Aspose.FileFormat.Emf ) представляет собой несжатый формат изображения и иногда требует много оперативной памяти для хранения и обработки документа. Эта опция позволяет преобразовать все изображения метафайла вF:Aspose.FileFormat.Png при загрузке документа. Обратите внимание - преобразование векторной графики в растровую снижает качество изображений.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | Преобразовывать ли метафайл (F:Aspose.FileFormat.Wmf или жеF:Aspose.FileFormat.Emf ) изображения вF:Aspose.FileFormat.Png формат изображения. |
setConvertShapeToOfficeMath(boolean value)
public void setConvertShapeToOfficeMath(boolean value)
Устанавливает, следует ли преобразовывать фигуры с EquationXML в объекты Office Math.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | Следует ли преобразовывать фигуры с помощью EquationXML в объекты Office Math. |
setEncoding(Charset value)
public void setEncoding(Charset value)
Задает кодировку, которая будет использоваться для загрузки документа HTML, TXT или CHM, если кодировка не указана внутри документа. Может быть нулевым. Значение по умолчанию равно нулю.
Это свойство используется только при загрузке документов HTML, TXT или CHM.
Если кодировка внутри документа не указана и это свойство равно null , то система попытается автоматически определить кодировку.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.nio.charset.Charset | Кодировка, которая будет использоваться для загрузки документа HTML, TXT или CHM, если кодировка не указана внутри документа. |
setFontSettings(FontSettings value)
public void setFontSettings(FontSettings value)
Позволяет указать настройки шрифта документа.
При загрузке некоторых форматов Aspose.Words может потребовать разрешения шрифтов. Например, при загрузке HTML-документов Aspose.Words может разрешить шрифты для выполнения резервного шрифта.
Если установлено значение null, настройки статического шрифта по умолчаниюFontSettings.getDefaultInstance() будет использован.
Значение по умолчанию равно нулю.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | FontSettings | СоответствующийFontSettings ценность. |
setLoadFormat(int value)
public void setLoadFormat(int value)
Задает формат загружаемого документа. По умолчаниюLoadFormat.AUTO.
Рекомендуется указатьLoadFormat.AUTOзначение и позволить Aspose.Words автоматически определить формат файла. Если вы знаете формат документа, который собираетесь загрузить, вы можете явно указать формат, и это немного сократит время загрузки за счет накладных расходов, связанных с автоматическим определением формата. Если вы укажете явный формат загрузки, и он окажется неверным, сработает автоопределение и будет предпринята вторая попытка загрузить файл.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int | Соответствующее целочисленное значение. Значение должно быть одним изLoadFormat константы. |
setMswVersion(int value)
public void setMswVersion(int value)
Позволяет указать, что процесс загрузки документа должен соответствовать конкретной версии MS Word. Значение по умолчаниюMsWordVersion.WORD_2019 Различные версии Word могут немного по-разному обрабатывать некоторые аспекты содержимого и форматирования документа в процессе загрузки, что может привести к незначительным различиям в объектной модели документа.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | int | Соответствующее целочисленное значение. Значение должно быть одним изMsWordVersion константы. |
setOriginalFileName(String value)
public void setOriginalFileName(String value)
Имя CHM-файла. Значение по умолчанию равно нулю.
Документы CHM могут содержать ссылки, ссылающиеся на один и тот же документ по имени файла. Aspose.Words поддерживает такие ссылки и обычно используетDocument.getOriginalFileName()чтобы проверить, является ли файл, на который ссылается ссылка, загружаемым файлом. Если документ загружается из потока, его оригинальное имя файла должно быть указано явно через это свойство, так как оно не может быть определено автоматически.
Если документ CHM загружается из файла и для этого свойства указано ненулевое значение, это значение будет иметь приоритет над фактическим именем файла, хранящегося вDocument.getOriginalFileName().
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.lang.String | Соответствующее значение java.lang.String. |
setPassword(String value)
public void setPassword(String value)
Устанавливает пароль для открытия зашифрованного документа. Может быть нулевой или пустой строкой. Значение по умолчанию равно нулю.
Вам нужно знать пароль, чтобы открыть зашифрованный документ. Если документ не зашифрован, установите для этого параметра значение null или пустую строку.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.lang.String | Пароль для открытия зашифрованного документа. |
setPreserveIncludePictureField(boolean value)
public void setPreserveIncludePictureField(boolean value)
Устанавливает, сохранять ли поле INCLUDEPICTURE при чтении форматов Microsoft Word. Значение по умолчанию неверно.
По умолчанию поле INCLUDEPICTURE преобразуется в объект формы. Вы можете переопределить это, если вам нужно сохранить поле, например, если вы хотите обновить его программно. Обратите внимание, однако, что этот подход не является общим для Aspose.Words. Используйте его на свой страх и риск.
Одним из возможных вариантов использования может быть использование MERGEFIELD в качестве дочернего поля для динамического изменения исходного пути изображения. В этом случае вам нужно сохранить INCLUDEPICTURE в модели.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | Сохранять ли поле INCLUDEPICTURE при чтении форматов Microsoft Word. |
setProgressCallback(IDocumentLoadingCallback value)
public void setProgressCallback(IDocumentLoadingCallback value)
Вызывается во время загрузки документа и принимает данные о ходе загрузки.
LoadFormat.DOCX, LoadFormat.FLAT_OPC, LoadFormat.DOCM, LoadFormat.DOTM, LoadFormat.DOTX, LoadFormat.MARKDOWN, LoadFormat.RTF, LoadFormat.WORD_ML, LoadFormat.DOC, LoadFormat.DOT, LoadFormat.ODT, LoadFormat.OTT поддерживаемые форматы.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | IDocumentLoadingCallback | СоответствующийIDocumentLoadingCallback ценность. |
setResourceLoadingCallback(IResourceLoadingCallback value)
public void setResourceLoadingCallback(IResourceLoadingCallback value)
Позволяет управлять загрузкой внешних ресурсов (изображений, таблиц стилей) при импорте документа из HTML, MHTML.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | IResourceLoadingCallback | СоответствующийIResourceLoadingCallback ценность. |
setTempFolder(String value)
public void setTempFolder(String value)
Позволяет использовать временные файлы при чтении документа. По умолчанию это свойство имеет значение null, и временные файлы не используются.
Папка должна существовать и быть доступной для записи, иначе будет выдано исключение.
Aspose.Words автоматически удаляет все временные файлы после завершения чтения.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | java.lang.String | Соответствующее значение java.lang.String. |
setUpdateDirtyFields(boolean value)
public void setUpdateDirtyFields(boolean value)
Указывает, следует ли обновлять поля с грязным атрибутом.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | boolean | Соответствующее логическое значение. |
setWarningCallback(IWarningCallback value)
public void setWarningCallback(IWarningCallback value)
Вызывается во время операции загрузки при обнаружении проблемы, которая может привести к потере точности данных или форматирования.
Параметры:
Параметр | Тип | Описание |
---|---|---|
value | IWarningCallback | СоответствующийIWarningCallback ценность. |
toString()
public String toString()
Возвращает: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Параметры:
Параметр | Тип | Описание |
---|---|---|
arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Параметры:
Параметр | Тип | Описание |
---|---|---|
arg0 | long | |
arg1 | int |