Класс Aspose::Pdf::HtmlSaveOptions

HtmlSaveOptions class

Параметры сохранения для экспорта в формат Html.

class HtmlSaveOptions : public Aspose::Pdf::UnifiedSaveOptions,
                        public Aspose::Pdf::IPageSetOptions,
                        public Aspose::Pdf::IPipelineOptions

Nested classes

Enums

ПеречислениеОписание
AntialiasingProcessingTypeЭтот enum описывает возможные меры антиалиасинга при конвертации.
FontEncodingRulesЭто перечисление определяет правила, которые настраивают логику кодирования.
FontSavingModesПеречисляет режимы, которые могут использоваться для сохранения шрифтов, указанных в сохранённом PDF.
HtmlImageTypeперечисляет возможные типы файлов изображений, которые могут быть сохранены как внешние ресурсы во время конвертации Pdf в Html.
HtmlMarkupGenerationModesИногда присутствуют специфические требования к создаваемому HTML. Этот enum определяет режимы подготовки HTML, которые могут использоваться при конвертации PDF в HTML для соответствия таким специфическим требованиям.
ImageParentTypesПеречисляет возможные типы родительских элементов изображения, к которым Image может относиться: страница HTML или родительское изображение SVG.
LettersPositioningMethodsОн перечисляет возможные режимы позиционирования букв в словах в результирующем HTML.
PartsEmbeddingModesЭтот enum перечисляет возможные режимы встраивания файлов, указанных в HTML It позволяет контролировать, будут ли ссылки на файлы (HTML, Fonts,Images, CSSes) встроены в основной HTML‑файл или созданы как отдельные бинарные сущности.
RasterImagesSavingModesКонвертированный PDF может содержать растровые изображения (.png, *.jpeg и т.д.). Этот enum определяет методы обработки растровых изображений при конвертации PDF в HTML.

Методы

МетодОписание
get_AdditionalMarginWidthInPoints() constЕсли атрибут ‘SplitOnPages=false’, тогда весь HTML, представляющий все входные страницы PDF, не будет разбит на отдельные HTML‑страницы, а будет помещён в один большой результирующий HTML‑файл. Однако каждая исходная страница PDF будет представлена своей прямоугольной областью в HTML (при необходимости эти области могут быть обведены, чтобы показать края листа с помощью специального атрибута ‘PageBorderIfAny’). Этот параметр определяет ширину отступа, который будет принудительно оставлен вокруг этих выходных HTML‑областей, представляющих страницы исходного PDF‑документа. По сути он задаёт гарантированный интервал между HTML‑представлениями “paper” страниц PDF в таком режиме конвертации.
get_BatchSize() overrideОпределяет размер пакета, если пакетная конвертация применима к паре форматов источника и назначения.
get_CompressSvgGraphicsIfAny() constПолучает флаг, указывающий, будут ли найденные SVG‑графики (если есть) сжаты (упакованы) в формат SVGZ при сохранении.
get_ConvertMarkedContentToLayers() constЕсли атрибут ConvertMarkedContentToLayers установлен в true, то все элементы внутри отмеченного содержимого PDF (слой) будут помещены в HTML‑div с атрибутом “data-pdflayer”, указывающим имя слоя. Это имя слоя будет извлечено из дополнительных свойств отмеченного содержимого PDF. Если этот атрибут установлен в false (по умолчанию), то никакие слои не будут созданы из отмеченного содержимого PDF.
get_DefaultFontName() constУказывает имя установленного шрифта, который используется для замены любого шрифта документа, не встроенного и не установленного в системе. Если значение null, используется шрифт замены по умолчанию.
get_DocumentType() constПолучает HtmlDocumentType.
get_ExplicitListOfSavedPages() overrideС помощью этого свойства вы можете явно задать, какие страницы документа следует конвертировать. Страницы в этом списке должны иметь нумерацию, начинающуюся с 1. Т.е. допустимые номера страниц должны быть взяты из диапазона (1…[NumberOfPagesInConvertedDocument]). Порядок появления страниц в этом списке не влияет на их порядок в результирующем HTML‑документе(ах) — в результирующих страницах они всегда будут идти в том порядке, в котором они присутствуют в исходном PDF. Если этот список равен null (как по умолчанию), будут конвертированы все страницы. Если любой номер страницы из этого списка выходит за пределы существующих страниц (1-[amountOfPagesInDocument]), будет выброшено исключение.
get_FixedLayout() constПолучает значение, указывающее, создан ли этот HTML в фиксированном макете.
get_FlowLayoutParagraphFullWidth() constЭтот атрибут задаёт текст абзаца полной ширины для режима Flow, FixedLayout = false.
get_FontSources() constИсточники шрифтов предварительно сохранённых шрифтов.
get_IgnoredTextFontSize() constText с указанным размером или меньше будет игнорироваться при конвертации. Мы не удаляем этот текст, а игнорируем его и не переносим в выходной файл.
get_IgnoreResourceFontErrors() constПолучает указание, что ошибки, связанные с отсутствием шрифта, будут игнорироваться. true — означает, что ошибки отсутствия шрифта будут игнорироваться. Сегменты Text, ссылающиеся на некорректные ресурсы, будут пропущены при обработке. По умолчанию false.
get_ImageResolution() constПолучает разрешение для рендеринга изображений.
get_MinimalLineWidth() constЭтот атрибут задаёт минимальную ширину линии графического пути. Если толщина линии меньше 1 px, Adobe Acrobat округляет её до этого значения. Поэтому этот атрибут можно использовать для эмуляции такого поведения в браузерах HTML.
get_PreventGlyphsGrouping() constЭтот атрибут включает режим, при котором глифы текста не будут группироваться в слова и строки. Этот режим позволяет сохранять максимальную точность позиционирования глифов на странице и может использоваться при конвертации документов с нотами или глифами, которые должны располагаться отдельно друг от друга. Этот параметр будет применён к документу только когда значение атрибута FixedLayout равно true.
get_RenderTextAsImage() constЕсли атрибут RenderTextAsImage установлен в true, текст из источника становится изображением в HTML. Это может быть полезно, чтобы сделать текст нечитаемым или если HTML‑текст отображается некорректно.
get_SaveFullFont() constУказывает, что будет сохраняться полный шрифт, поддерживает только True Type шрифты. По умолчанию SaveFullFont = false, и конвертер сохраняет подмножество исходного шрифта, необходимое для отображения текста документа.
get_SimpleTextboxModeGrouping() constЭтот атрибут задает последовательную группировку глифов и слов в строки. Например, теги и слова имеют разный порядок в преобразованном HTML, и вы хотите, чтобы они совпадали. Этот параметр будет применён к документу только когда значение атрибута FixedLayout равно true.
get_SplitCssIntoPages() constКогда выбран режим мультистраничности (т.е. ‘SplitIntoPages’ = ’true’), этот атрибут определяет, следует ли создавать отдельный CSS‑файл для каждой результирующей HTML‑страницы. По умолчанию атрибут имеет значение false, поэтому создаётся один большой общий CSS для всех созданных страниц. Суммарный размер всех CSS‑файлов, генерируемых в этом режиме (по одному CSS на страницу), обычно значительно превышает размер одного большого CSS‑файла, потому что в первом случае классы CSS дублируются в нескольких файлах для каждой страницы. Поэтому данная настройка целесообразна только тогда, когда вам требуется последующая обработка каждой HTML‑страницы независимо, и, следовательно, размер CSS каждой отдельной страницы является критическим фактором.
get_SplitIntoPages() constВозвращает флаг, указывающий, будет ли каждая страница исходного документа конвертироваться в отдельный целевой HTML‑документ, т.е. будет ли результирующий HTML разбит на несколько HTML‑страниц.
get_Title() constВозвращает заголовок HTML‑страницы.
get_TryMergeFragments() constФлаг, определяющий объединение фрагментов изображения в одну картинку.
get_UseZOrder() constЕсли атрибут UseZORder установлен в true, графика и текст добавляются в результирующий HTML‑документ в соответствии с Z‑порядком в оригинальном PDF‑документе. Если атрибут имеет значение false, вся графика помещается в один слой, что может вызвать нежелательные эффекты для перекрывающихся объектов.
HtmlSaveOptions()Инициализирует новый экземпляр класса HtmlSaveOptions.
HtmlSaveOptions(HtmlDocumentType)Инициализирует новый экземпляр класса HtmlSaveOptions.
HtmlSaveOptions(bool)Инициализирует новый экземпляр класса HtmlSaveOptions.
HtmlSaveOptions(HtmlDocumentType, bool)Инициализирует новый экземпляр класса HtmlSaveOptions.
set_AdditionalMarginWidthInPoints(int32_t)Если атрибут ‘SplitOnPages=false’, тогда весь HTML, представляющий все входные страницы PDF, не будет разбит на отдельные HTML‑страницы, а будет помещён в один большой результирующий HTML‑файл. Однако каждая исходная страница PDF будет представлена своей прямоугольной областью в HTML (при необходимости эти области могут быть обведены, чтобы показать края листа с помощью специального атрибута ‘PageBorderIfAny’). Этот параметр определяет ширину отступа, который будет принудительно оставлен вокруг этих выходных HTML‑областей, представляющих страницы исходного PDF‑документа. По сути он задаёт гарантированный интервал между HTML‑представлениями “paper” страниц PDF в таком режиме конвертации.
set_BatchSize(int32_t) overrideОпределяет размер пакета, если пакетная конвертация применима к паре форматов источника и назначения.
set_CompressSvgGraphicsIfAny(bool)Устанавливает флаг, указывающий, будет ли найденная SVG‑графика (если есть) сжиматься (архивироваться) в формат SVGZ при сохранении.
set_ConvertMarkedContentToLayers(bool)Если атрибут ConvertMarkedContentToLayers установлен в true, то все элементы внутри отмеченного содержимого PDF (слой) будут помещены в HTML‑div с атрибутом “data-pdflayer”, указывающим имя слоя. Это имя слоя будет извлечено из дополнительных свойств отмеченного содержимого PDF. Если этот атрибут установлен в false (по умолчанию), то никакие слои не будут созданы из отмеченного содержимого PDF.
set_DefaultFontName(const System::String&)Указывает имя установленного шрифта, который используется для замены любого шрифта документа, не встроенного и не установленного в системе. Если значение null, используется шрифт замены по умолчанию.
set_DocumentType(HtmlDocumentType)Задаёт значение HtmlDocumentType.
set_ExplicitListOfSavedPages(System::ArrayPtr<int32_t>) overrideС помощью этого свойства вы можете явно задать, какие страницы документа следует конвертировать. Страницы в этом списке должны иметь нумерацию, начинающуюся с 1. Т.е. допустимые номера страниц должны быть взяты из диапазона (1…[NumberOfPagesInConvertedDocument]). Порядок появления страниц в этом списке не влияет на их порядок в результирующем HTML‑документе(ах) — в результирующих страницах они всегда будут идти в том порядке, в котором они присутствуют в исходном PDF. Если этот список равен null (как по умолчанию), будут конвертированы все страницы. Если любой номер страницы из этого списка выходит за пределы существующих страниц (1-[amountOfPagesInDocument]), будет выброшено исключение.
set_FixedLayout(bool)Устанавливает значение, указывающее, создаётся ли HTML в виде фиксированного макета.
set_FlowLayoutParagraphFullWidth(bool)Этот атрибут задаёт текст абзаца полной ширины для режима Flow, FixedLayout = false.
set_IgnoredTextFontSize(System::Nullable<float>)Text с указанным размером или меньше будет игнорироваться при конвертации. Мы не удаляем этот текст, а игнорируем его и не переносим в выходной файл.
set_IgnoreResourceFontErrors(bool)Устанавливает индикатор, указывающий, что ошибки, связанные с отсутствием шрифта, будут игнорироваться. true — означает, что ошибки отсутствия шрифта будут игнорироваться. Сегменты Text, ссылающиеся на некорректные ресурсы, будут пропускаться при обработке. По умолчанию false.
set_ImageResolution(int32_t)Устанавливает разрешение для рендеринга изображений.
set_MinimalLineWidth(float)Этот атрибут задаёт минимальную ширину линии графического пути. Если толщина линии меньше 1 px, Adobe Acrobat округляет её до этого значения. Поэтому этот атрибут можно использовать для эмуляции такого поведения в браузерах HTML.
set_PreventGlyphsGrouping(bool)Этот атрибут включает режим, при котором глифы текста не будут группироваться в слова и строки. Этот режим позволяет сохранять максимальную точность позиционирования глифов на странице и может использоваться при конвертации документов с нотами или глифами, которые должны располагаться отдельно друг от друга. Этот параметр будет применён к документу только когда значение атрибута FixedLayout равно true.
set_RenderTextAsImage(bool)Если атрибут RenderTextAsImage установлен в true, текст из источника становится изображением в HTML. Это может быть полезно, чтобы сделать текст нечитаемым или если HTML‑текст отображается некорректно.
set_SaveFullFont(bool)Указывает, что будет сохраняться полный шрифт, поддерживает только True Type шрифты. По умолчанию SaveFullFont = false, и конвертер сохраняет подмножество исходного шрифта, необходимое для отображения текста документа.
set_SimpleTextboxModeGrouping(bool)Этот атрибут задает последовательную группировку глифов и слов в строки. Например, теги и слова имеют разный порядок в преобразованном HTML, и вы хотите, чтобы они совпадали. Этот параметр будет применён к документу только когда значение атрибута FixedLayout равно true.
set_SplitCssIntoPages(bool)Когда выбран режим мультистраничности (т.е. ‘SplitIntoPages’ = ’true’), этот атрибут определяет, следует ли создавать отдельный CSS‑файл для каждой результирующей HTML‑страницы. По умолчанию атрибут имеет значение false, поэтому создаётся один большой общий CSS для всех созданных страниц. Суммарный размер всех CSS‑файлов, генерируемых в этом режиме (по одному CSS на страницу), обычно значительно превышает размер одного большого CSS‑файла, потому что в первом случае классы CSS дублируются в нескольких файлах для каждой страницы. Поэтому данная настройка целесообразна только тогда, когда вам требуется последующая обработка каждой HTML‑страницы независимо, и, следовательно, размер CSS каждой отдельной страницы является критическим фактором.
set_SplitIntoPages(bool)Устанавливает флаг, указывающий, будет ли каждая страница исходного документа конвертироваться в отдельный целевой HTML‑документ, т.е. будет ли результирующий HTML разбит на несколько HTML‑страниц.
set_Title(const System::String&)Устанавливает заголовок HTML‑страницы.
set_TryMergeFragments(bool)Флаг, определяющий объединение фрагментов изображения в одну картинку.
set_UseZOrder(bool)Если атрибут UseZORder установлен в true, графика и текст добавляются в результирующий HTML‑документ в соответствии с Z‑порядком в оригинальном PDF‑документе. Если атрибут имеет значение false, вся графика помещается в один слой, что может вызвать нежелательные эффекты для перекрывающихся объектов.

Typedefs

Типовое определениеОписание
CssSavingStrategyВы можете назначить этому свойству пользовательскую стратегию, реализующую обработку и/или сохранение части CSS, созданной при конвертации PDF в HTML. В этом случае обработка (например, сохранение в поток или на диск) должна выполняться в этом пользовательском коде.
CssUrlMakingStrategyВы можете назначить этому свойству делегат, созданный из пользовательского метода, который реализует создание URL CSS, на который ссылается сгенерированный HTML‑документ. Например, если вы хотите, чтобы CSS в HTML ссылался, например, как "otherPage.ASPX?CssID=zjjkklj", то такая пользовательская стратегия должна возвращать "otherPage.ASPX?CssID=zjjkklj".
HtmlPageMarkupSavingStrategyРезультат конвертации может содержать одну или несколько HTML‑страниц (которые также могут ссылаться на внешние файлы, такие как изображения или шрифты). Вы можете назначить этому свойству делегат, созданный из пользовательского метода, который реализует обработку полученной HTML‑страницы (самого HTML), созданной во время конвертации. В этом случае обработка (например, сохранение в поток или на диск) может выполняться в этом пользовательском коде. При этом все необходимые действия по сохранению разметки HTML‑страницы должны быть выполнены в коде предоставленного метода, поскольку сохранение результата в коде конвертера использоваться не будет. Если по какой‑то причине обработку в данном случае необходимо выполнить кодом конвертера, а не пользовательским кодом, пожалуйста, установите в пользовательском коде флаг ‘CustomProcessingCancelled’ переменной параметра ‘htmlSavingInfo’: это сигнализирует конвертеру, что все необходимые шаги по обработке данного ресурса должны быть выполнены самим конвертером так же, как если бы внешнего пользовательского кода сохранения не было.
ResourceSavingStrategyДля этого свойства вы можете назначить делегат, созданный из пользовательского метода, который реализует обработку внешнего ресурса (шрифта или изображения), извлечённого из PDF и который должен быть сохранён как внешний ресурс при конвертации PDF в HTML. В этом случае обработка (например, сохранение в поток или на диск) может выполняться в этом пользовательском коде, и этот код должен возвращать путь (или любую другую строку без кавычек), который затем будет включён в сгенерированный HTML вместо исходного предполагаемого пути к ресурсу изображения. При этом все необходимые действия по сохранению изображения должны быть выполнены в коде предоставленного метода, поскольку сохранение результата в коде конвертера использоваться не будет. Если по какой‑то причине обработку данного файла необходимо выполнить кодом конвертера, а не пользовательским кодом, пожалуйста, установите в пользовательском коде флаг ‘CustomProcessingCancelled’ переменной параметра ‘resourceSavingInfo’. Это сигнализирует конвертеру, что все необходимые шаги по обработке данного ресурса должны быть выполнены самим конвертером, как если бы внешнего пользовательского кода не было.

См. также