HtmlSaveOptions.HtmlImageSavingInfo

Inheritance: java.lang.Object, com.aspose.pdf.SaveOptions.ResourceSavingInfo

public static class HtmlSaveOptions.HtmlImageSavingInfo extends SaveOptions.ResourceSavingInfo

This class represents set of data that related to external resource image file’s saving during PDF to HTML conversion.

Constructors

ConstructorDescription
HtmlImageSavingInfo()creates new instance of HtmlImageSavingInfo

Methods

MethodDescription
getImageType()Represents type of saved image referenced in HTML.
setImageType(int imageType)Represents type of saved image referenced in HTML.
getParentType()Saved image can pertain to HTML itself or can be extracted.
setParentType(int parentType)Saved image can pertain to HTML itself or can be extracted.
getPdfHostPageNumber()Tells to custom code to what page of original PDF document pertains saved image Since it’s possible that will be saved not all pages of original document, this value tells us about host page number in original PDF.
setPdfHostPageNumber(int pdfHostPageNumber)Tells to custom code to what page of original PDF document pertains saved image Since it’s possible that will be saved not all pages of original document, this value tells us about host page number in original PDF.
getHtmlHostPageNumber()Tells to custom code to what page of generated set of HTML page-files pertains saved image.
setHtmlHostPageNumber(int htmlHostPageNumber)Tells to custom code to what page of generated set of HTML page-files pertains saved image.

HtmlImageSavingInfo()

public HtmlImageSavingInfo()

creates new instance of HtmlImageSavingInfo

getImageType()

public int getImageType()

Represents type of saved image referenced in HTML. Set by converter and can be used in custom code to decide what should be done

Returns: int - HtmlImageType element

setImageType(int imageType)

public void setImageType(int imageType)

Represents type of saved image referenced in HTML. Set by converter and can be used in custom code to decide what should be done

Parameters:

ParameterTypeDescription
imageTypeintHtmlImageType element

getParentType()

public int getParentType()

Saved image can pertain to HTML itself or can be extracted. from SVG embedded to HTML. This property can tell to custom code what’s that type of parent of processed image. It set by converter and can be used in custom code to decide what should be done with that image (f.e. custom code can decide where to save image or how it must be referenced in parent’s content).

Returns: int - ImageParentTypes element

setParentType(int parentType)

public void setParentType(int parentType)

Saved image can pertain to HTML itself or can be extracted. from SVG embedded to HTML. This property can tell to custom code what’s that type of parent of processed image. It set by converter and can be used in custom code to decide what should be done with that image (f.e. custom code can decide where to save image or how it must be referenced in parent’s content).

Parameters:

ParameterTypeDescription
parentTypeintImageParentTypes element

getPdfHostPageNumber()

public int getPdfHostPageNumber()

Tells to custom code to what page of original PDF document pertains saved image Since it’s possible that will be saved not all pages of original document, this value tells us about host page number in original PDF. If original page number for some reason is unknown, it always return ‘1’

Returns: int - int value

setPdfHostPageNumber(int pdfHostPageNumber)

public void setPdfHostPageNumber(int pdfHostPageNumber)

Tells to custom code to what page of original PDF document pertains saved image Since it’s possible that will be saved not all pages of original document, this value tells us about host page number in original PDF. If original page number for some reason is unknown, it always return ‘1’

Parameters:

ParameterTypeDescription
pdfHostPageNumberintint value

getHtmlHostPageNumber()

public int getHtmlHostPageNumber()

Tells to custom code to what page of generated set of HTML page-files pertains saved image. If splitting on pages turned off this value always contains ‘1’ since in such case Only one HTML page is generated.

Returns: int - int value

setHtmlHostPageNumber(int htmlHostPageNumber)

public void setHtmlHostPageNumber(int htmlHostPageNumber)

Tells to custom code to what page of generated set of HTML page-files pertains saved image. If splitting on pages turned off this value always contains ‘1’ since in such case Only one HTML page is generated.

Parameters:

ParameterTypeDescription
htmlHostPageNumberintint value