models

package
v1.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 7, 2024 License: MIT Imports: 1 Imported by: 13

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiError 

type ApiError struct {
	Code        string    `json:"Code,omitempty"`
	Message     string    `json:"Message,omitempty"`
	Description string    `json:"Description,omitempty"`
	DateTime    time.Time `json:"DateTime,omitempty"`
	InnerError  *ApiError `json:"InnerError,omitempty"`
}

type ApiErrorResponse 

type ApiErrorResponse struct {
	RequestId string    `json:"RequestId,omitempty"`
	Error_    *ApiError `json:"Error,omitempty"`
}

type CadLoadOptions 

type CadLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Render specific CAD layouts
	LayoutNames []string `json:"LayoutNames,omitempty"`
	// Gets or sets a background color.
	BackgroundColor string       `json:"BackgroundColor,omitempty"`
	DrawType        DrawTypeEnum `json:"DrawType,omitempty"`
}

Options for loading CAD documents

type ColorModeEnum added in v1.0.2 

type ColorModeEnum string
const (
	ColorModeEnumBitmap       ColorModeEnum = "Bitmap"
	ColorModeEnumGrayscale    ColorModeEnum = "Grayscale"
	ColorModeEnumIndexed      ColorModeEnum = "Indexed"
	ColorModeEnumRgb          ColorModeEnum = "Rgb"
	ColorModeEnumCmyk         ColorModeEnum = "Cmyk"
	ColorModeEnumMultichannel ColorModeEnum = "Multichannel"
	ColorModeEnumDuotone      ColorModeEnum = "Duotone"
	ColorModeEnumLab          ColorModeEnum = "Lab"
)

type CompressionEnum added in v1.0.2 

type CompressionEnum string
const (
	CompressionEnumLzw    CompressionEnum = "Lzw"
	CompressionEnumNone   CompressionEnum = "None"
	CompressionEnumCcitt3 CompressionEnum = "Ccitt3"
	CompressionEnumCcitt4 CompressionEnum = "Ccitt4"
	CompressionEnumRle    CompressionEnum = "Rle"
)

type CompressionMethodEnum added in v1.0.2 

type CompressionMethodEnum string
const (
	CompressionMethodEnumRaw                  CompressionMethodEnum = "Raw"
	CompressionMethodEnumRle                  CompressionMethodEnum = "Rle"
	CompressionMethodEnumZipWithoutPrediction CompressionMethodEnum = "ZipWithoutPrediction"
	CompressionMethodEnumZipWithPrediction    CompressionMethodEnum = "ZipWithPrediction"
)

type ConsumptionResult 

type ConsumptionResult struct {
	// Amount of used credits
	Credit float32 `json:"Credit"`
	// Amount of MBs processed
	Quantity float32 `json:"Quantity"`
}

Metered license consumption information

type ConvertOptions 

type ConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
}

ConvertOptions base

type ConvertSettings 

type ConvertSettings struct {
	// StorageName which contains the file
	StorageName string `json:"StorageName,omitempty"`
	// Gets or sets absolute path to a file in the storage
	FilePath string `json:"FilePath"`
	// Gets or sets requested conversion format
	Format string `json:"Format"`
	// Gets or sets format specific load options for source file
	LoadOptions interface{} `json:"LoadOptions,omitempty"`
	// Gets or sets format specific convert options for output file
	ConvertOptions interface{} `json:"ConvertOptions,omitempty"`
	// Gets or sets converted file save path
	OutputPath string `json:"OutputPath,omitempty"`
	// The path to directory containing custom fonts in storage
	FontsPath string `json:"FontsPath,omitempty"`
}

Defines conversion request

type CsvLoadOptions 

type CsvLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Default font for Cells document. The following font will be used if a font is missing.
	DefaultFont string `json:"DefaultFont,omitempty"`
	// Substitute specific fonts when converting Cells document.
	FontSubstitutes map[string]string `json:"FontSubstitutes,omitempty"`
	// Show grid lines when converting Excel files
	ShowGridLines bool `json:"ShowGridLines,omitempty"`
	// Show hidden sheets when converting Excel files
	ShowHiddenSheets bool `json:"ShowHiddenSheets,omitempty"`
	// If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is true.
	OnePagePerSheet bool `json:"OnePagePerSheet,omitempty"`
	// Convert specific range when converting to other than cells format. Example: \"D1:F8\"
	ConvertRange string `json:"ConvertRange,omitempty"`
	// Skips empty rows and columns when converting. Default is True.
	SkipEmptyRowsAndColumns bool `json:"SkipEmptyRowsAndColumns,omitempty"`
	// Set password to unprotect protected document
	Password string `json:"Password,omitempty"`
	// Hide comments
	HideComments bool `json:"HideComments,omitempty"`
	// Delimiter of a Csv file
	Separator string `json:"Separator,omitempty"`
	// True means the file contains several encodings
	IsMultiEncoded bool `json:"IsMultiEncoded,omitempty"`
	// Indicates whether text is formula if it starts with \"=\"
	HasFormula bool `json:"HasFormula,omitempty"`
	// Indicates whether the string in the file is converted to numeric. Default is True
	ConvertNumericData bool `json:"ConvertNumericData,omitempty"`
	// Indicates whether the string in the file is converted to date. Default is True
	ConvertDateTimeData bool `json:"ConvertDateTimeData,omitempty"`
	// File encoding
	Encoding string `json:"Encoding,omitempty"`
}

Csv document load options

type DiagramLoadOptions 

type DiagramLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Default font for Diagram document. The following font will be used if a font is missing.
	DefaultFont string `json:"DefaultFont,omitempty"`
}

Diagram document load options

type DirectionEnum added in v1.0.2 

type DirectionEnum string
const (
	DirectionEnumL2R DirectionEnum = "L2R"
	DirectionEnumR2L DirectionEnum = "R2L"
)

type DiscUsage 

type DiscUsage struct {
	// Application used disc space.
	UsedSize int64 `json:"UsedSize"`
	// Total disc space.
	TotalSize int64 `json:"TotalSize"`
}

Class for disc space information.

type DocumentMetadata 

type DocumentMetadata struct {
	// Document file type
	FileType string `json:"FileType,omitempty"`
	// Gets pages count if applicable to the current document format
	PageCount int32 `json:"PageCount"`
	// Document bytes size
	Size int64 `json:"Size"`
	// Returns detected width if applicable to the current document format
	Width int32 `json:"Width"`
	// Returns detected height if applicable to the current document format
	Height int32 `json:"Height"`
	// Returns detected horizontal resolution if applicable to the current document format
	HorizontalResolution int32 `json:"HorizontalResolution"`
	// Returns detected vertical resolution if applicable to the current document format
	VerticalResolution int32 `json:"VerticalResolution"`
	// Returns detected bits per pixel if applicable to the current document format
	BitsPerPixel int32 `json:"BitsPerPixel"`
	// Returns document title width if applicable to the current document format
	Title string `json:"Title,omitempty"`
	// Returns detected document author if applicable to the current document format
	Author string `json:"Author,omitempty"`
	// Returns detected document creation date if it's applicable to the current document format
	CreatedDate time.Time `json:"CreatedDate"`
	// Returns detected document modification date if applicable to the current document format
	ModifiedDate time.Time `json:"ModifiedDate"`
	// Returns list of layer names if applicable to the current document format
	Layers []string `json:"Layers,omitempty"`
	// Is document password protected
	IsPasswordProtected bool `json:"IsPasswordProtected"`
}

Contains a document metadata

type DrawTypeEnum added in v1.0.2 

type DrawTypeEnum string
const (
	DrawTypeEnumUseDrawColor   DrawTypeEnum = "UseDrawColor"
	DrawTypeEnumUseObjectColor DrawTypeEnum = "UseObjectColor"
)

type EBookConvertOptions 

type EBookConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions   `json:"WatermarkOptions,omitempty"`
	PageSize         PageSizeEnum        `json:"PageSize,omitempty"`
	PageOrientation  PageOrientationEnum `json:"PageOrientation,omitempty"`
}

Ebook convert options

type EmailLoadOptions 

type EmailLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Option to display or hide the email header. Default: true
	DisplayHeader bool `json:"DisplayHeader,omitempty"`
	// Option to display or hide \"from\" email address. Default: true
	DisplayFromEmailAddress bool `json:"DisplayFromEmailAddress"`
	// Option to display or hide \"to\" email address. Default: true
	DisplayToEmailAddress bool `json:"DisplayToEmailAddress"`
	// Option to display or hide \"Cc\" email address. Default: false
	DisplayCcEmailAddress bool `json:"DisplayCcEmailAddress"`
	// Option to display or hide \"Bcc\" email address. Default: false
	DisplayBccEmailAddress bool `json:"DisplayBccEmailAddress"`
	// Gets or sets the Coordinated Universal Time (UTC) offset for the message dates. This property defines the time zone difference, between the localtime and UTC.
	TimeZoneOffset string `json:"TimeZoneOffset,omitempty"`
	// Option to convert attachments in source email or not. Default: false.
	ConvertAttachments bool `json:"ConvertAttachments"`
	// The mapping between email message field and field text representation
	FieldLabels []FieldLabel `json:"FieldLabels,omitempty"`
	// Defines whether need to keep original date header string in mail message when saving or not (Default value is true)
	PreserveOriginalDate bool `json:"PreserveOriginalDate,omitempty"`
}

Options for loading Email documents

type ErrorDetails 

type ErrorDetails struct {
	// The request id
	RequestId string `json:"RequestId,omitempty"`
	// Date
	Date time.Time `json:"Date"`
}

The error details

type FieldEnum added in v1.0.2 

type FieldEnum string

FieldEnum is the enum type for email fields 

const (
	FieldEnumStart             FieldEnum = "Start"
	FieldEnumTabField          FieldEnum = "TabField"
	FieldEnumSubject           FieldEnum = "Subject"
	FieldEnumShowTimeAs        FieldEnum = "ShowTimeAs"
	FieldEnumSent              FieldEnum = "Sent"
	FieldEnumRequiredAttendees FieldEnum = "RequiredAttendees"
	FieldEnumRecurrencePattern FieldEnum = "RecurrencePattern"
	FieldEnumRecurrence        FieldEnum = "Recurrence"
	FieldEnumPageHeader        FieldEnum = "PageHeader"
	FieldEnumOrganizer         FieldEnum = "Organizer"
	FieldEnumLocation          FieldEnum = "Location"
	FieldEnumImportance        FieldEnum = "Importance"
	FieldEnumFrom              FieldEnum = "From"
	FieldEnumEnd               FieldEnum = "End"
	FieldEnumBcc               FieldEnum = "Bcc"
	FieldEnumAttachments       FieldEnum = "Attachments"
	FieldEnumTo                FieldEnum = "To"
)

Define the constants for FieldEnum with string values

type FieldLabel 

type FieldLabel struct {
	Field FieldEnum `json:"Field"`
	// The label e.g. \"Sender\"
	Label string `json:"Label,omitempty"`
}

Represents field label

type FileVersion 

type FileVersion struct {
	// File or folder name.
	Name string `json:"Name,omitempty"`
	// True if it is a folder.
	IsFolder bool `json:"IsFolder"`
	// File or folder last modified DateTime.
	ModifiedDate time.Time `json:"ModifiedDate,omitempty"`
	// File or folder size.
	Size int64 `json:"Size"`
	// File or folder path.
	Path string `json:"Path,omitempty"`
	// File Version ID.
	VersionId string `json:"VersionId,omitempty"`
	// Specifies whether the file is (true) or is not (false) the latest version of an file.
	IsLatest bool `json:"IsLatest"`
}

File Version

type FileVersions 

type FileVersions struct {
	// File versions FileVersion.
	Value []FileVersion `json:"Value,omitempty"`
}

File versions FileVersion.

type FilesList 

type FilesList struct {
	// Files and folders contained by folder StorageFile.
	Value []StorageFile `json:"Value,omitempty"`
}

Files list

type FilesUploadResult 

type FilesUploadResult struct {
	// List of uploaded file names
	Uploaded []string `json:"Uploaded,omitempty"`
	// List of errors.
	Errors []ModelError `json:"Errors,omitempty"`
}

File upload result

type FlipModeEnum added in v1.0.2 

type FlipModeEnum string
const (
	FlipModeEnumNone   FlipModeEnum = "None"
	FlipModeEnumFlipX  FlipModeEnum = "FlipX"
	FlipModeEnumFlipY  FlipModeEnum = "FlipY"
	FlipModeEnumFlipXY FlipModeEnum = "FlipXY"
)

type HtmlRenderingModeEnum added in v1.0.4 

type HtmlRenderingModeEnum string
const (
	HtmlRenderingModeEnumFlow     HtmlRenderingModeEnum = "Flow"
	HtmlRenderingModeEnumAbsolute HtmlRenderingModeEnum = "AbsolutePositioning"
)

type ImageConvertOptions 

type ImageConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Desired image width after conversion
	Width int32 `json:"Width,omitempty"`
	// Desired image height after conversion
	Height int32 `json:"Height,omitempty"`
	// Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96dpi
	HorizontalResolution int32 `json:"HorizontalResolution,omitempty"`
	// Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96dpi
	VerticalResolution int32 `json:"VerticalResolution,omitempty"`
	// Convert to grayscale image
	Grayscale bool `json:"Grayscale,omitempty"`
	// Image rotation angle
	RotateAngle int32 `json:"RotateAngle,omitempty"`
	// If true, the input firstly is converted to PDF and after that to desired format
	UsePdf bool `json:"UsePdf,omitempty"`
	// Adjust image brightness
	Brightness int32 `json:"Brightness,omitempty"`
	// Adjust image contrast
	Contrast int32 `json:"Contrast,omitempty"`
	// Adjust image gamma
	Gamma    float64      `json:"Gamma,omitempty"`
	FlipMode FlipModeEnum `json:"FlipMode,omitempty"`
}

Options for to Image conversion

type ImageLoadOptions 

type ImageLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Default font for Psd, Emf, Wmf document types. The following font will be used if a font is missing.
	DefaultFont string `json:"DefaultFont,omitempty"`
}

Image document load options

type JpgConvertOptions 

type JpgConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Desired image width after conversion
	Width int32 `json:"Width,omitempty"`
	// Desired image height after conversion
	Height int32 `json:"Height,omitempty"`
	// Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96dpi
	HorizontalResolution int32 `json:"HorizontalResolution,omitempty"`
	// Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96dpi
	VerticalResolution int32 `json:"VerticalResolution,omitempty"`
	// Convert to grayscale image
	Grayscale bool `json:"Grayscale,omitempty"`
	// Image rotation angle
	RotateAngle int32 `json:"RotateAngle,omitempty"`
	// If true, the input firstly is converted to PDF and after that to desired format
	UsePdf bool `json:"UsePdf,omitempty"`
	// Adjust image brightness
	Brightness int32 `json:"Brightness,omitempty"`
	// Adjust image contrast
	Contrast int32 `json:"Contrast,omitempty"`
	// Adjust image gamma
	Gamma    float64      `json:"Gamma,omitempty"`
	FlipMode FlipModeEnum `json:"FlipMode,omitempty"`
	// Desired image quality when converting to Jpeg. The value must be between 0 and 100. The default value is 100.
	Quality int32 `json:"Quality,omitempty"`
}

Jpg convert options

type LeadingSpacesOptionsEnum added in v1.0.2 

type LeadingSpacesOptionsEnum string
const (
	LeadingSpacesOptionsEnumConvertToIndent LeadingSpacesOptionsEnum = "ConvertToIndent"
	LeadingSpacesOptionsEnumPreserve        LeadingSpacesOptionsEnum = "Preserve"
	LeadingSpacesOptionsEnumTrim            LeadingSpacesOptionsEnum = "Trim"
)

type LicenseInfo 

type LicenseInfo struct {
	// True, if license was applied and valid, otherwise False
	IsLicensed bool `json:"IsLicensed"`
}

Current license information

type LoadOptions 

type LoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
}

Load document options

type MethodEnum added in v1.0.2 

type MethodEnum string
const (
	MethodEnumConvert        MethodEnum = "Convert"
	MethodEnumConvertAndSave MethodEnum = "ConvertAndSave"
)

type ModelError 

type ModelError struct {
	// Code
	Code string `json:"Code,omitempty"`
	// Message
	Message string `json:"Message,omitempty"`
	// Description
	Description string `json:"Description,omitempty"`
	// Inner Error
	InnerError *ErrorDetails `json:"InnerError,omitempty"`
}

Error

type NonFullScreenPageModeEnum added in v1.0.2 

type NonFullScreenPageModeEnum string
const (
	NonFullScreenPageModeEnumUseNone        NonFullScreenPageModeEnum = "UseNone"
	NonFullScreenPageModeEnumUseOutlines    NonFullScreenPageModeEnum = "UseOutlines"
	NonFullScreenPageModeEnumUseThumbs      NonFullScreenPageModeEnum = "UseThumbs"
	NonFullScreenPageModeEnumFullScreen     NonFullScreenPageModeEnum = "FullScreen"
	NonFullScreenPageModeEnumUseOC          NonFullScreenPageModeEnum = "UseOC"
	NonFullScreenPageModeEnumUseAttachments NonFullScreenPageModeEnum = "UseAttachments"
)

type ObjectExist 

type ObjectExist struct {
	// Indicates that the file or folder exists.
	Exists bool `json:"Exists"`
	// True if it is a folder, false if it is a file.
	IsFolder bool `json:"IsFolder"`
}

Object exists

type OneLoadOptions 

type OneLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Default font for Note document. The following font will be used if a font is missing.
	DefaultFont string `json:"DefaultFont,omitempty"`
	// Substitute specific fonts when converting Note document.
	FontSubstitutes map[string]string `json:"FontSubstitutes,omitempty"`
	// Set password to unprotect protected document
	Password string `json:"Password,omitempty"`
}

One document load options

type OperationResult 

type OperationResult struct {
	Id       string                  `json:"Id"`
	Method   MethodEnum              `json:"Method"`
	Status   StatusEnum              `json:"Status"`
	Created  time.Time               `json:"Created,omitempty"`
	Started  time.Time               `json:"Started,omitempty"`
	Failed   time.Time               `json:"Failed,omitempty"`
	Canceled time.Time               `json:"Canceled,omitempty"`
	Finished time.Time               `json:"Finished,omitempty"`
	Result   []StoredConvertedResult `json:"Result,omitempty"`
	Error_   string                  `json:"Error,omitempty"`
}

Operation status result

type PageLayoutEnum added in v1.0.2 

type PageLayoutEnum string
const (
	PageLayoutEnumDefault        PageLayoutEnum = "Default"
	PageLayoutEnumSinglePage     PageLayoutEnum = "SinglePage"
	PageLayoutEnumOneColumn      PageLayoutEnum = "OneColumn"
	PageLayoutEnumTwoColumnLeft  PageLayoutEnum = "TwoColumnLeft"
	PageLayoutEnumTwoColumnRight PageLayoutEnum = "TwoColumnRight"
	PageLayoutEnumTwoPageLeft    PageLayoutEnum = "TwoPageLeft"
	PageLayoutEnumTwoPageRight   PageLayoutEnum = "TwoPageRight"
)

type PageModeEnum added in v1.0.2 

type PageModeEnum string
const (
	PageModeEnumUseNone        PageModeEnum = "UseNone"
	PageModeEnumUseOutlines    PageModeEnum = "UseOutlines"
	PageModeEnumUseThumbs      PageModeEnum = "UseThumbs"
	PageModeEnumFullScreen     PageModeEnum = "FullScreen"
	PageModeEnumUseOC          PageModeEnum = "UseOC"
	PageModeEnumUseAttachments PageModeEnum = "UseAttachments"
)

type PageOrientationEnum added in v1.0.2 

type PageOrientationEnum string
const (
	PageOrientationEnumDefault   PageOrientationEnum = "Default"
	PageOrientationEnumLandscape PageOrientationEnum = "Landscape"
	PageOrientationEnumPortrait  PageOrientationEnum = "Portrait"
)

type PageSizeEnum added in v1.0.2 

type PageSizeEnum string
const (
	PageSizeEnumDefault    PageSizeEnum = "Default"
	PageSizeEnumA3         PageSizeEnum = "A3"
	PageSizeEnumStatement  PageSizeEnum = "Statement"
	PageSizeEnumQuarto     PageSizeEnum = "Quarto"
	PageSizeEnumPaper11x17 PageSizeEnum = "Paper11x17"
	PageSizeEnumPaper10x14 PageSizeEnum = "Paper10x14"
	PageSizeEnumLetter     PageSizeEnum = "Letter"
	PageSizeEnumLegal      PageSizeEnum = "Legal"
	PageSizeEnumLedger     PageSizeEnum = "Ledger"
	PageSizeEnumFolio      PageSizeEnum = "Folio"
	PageSizeEnumExecutive  PageSizeEnum = "Executive"
	PageSizeEnumEnvelopeDL PageSizeEnum = "EnvelopeDL"
	PageSizeEnumCustom     PageSizeEnum = "Custom"
	PageSizeEnumB5         PageSizeEnum = "B5"
	PageSizeEnumB4         PageSizeEnum = "B4"
	PageSizeEnumA5         PageSizeEnum = "A5"
	PageSizeEnumA4         PageSizeEnum = "A4"
	PageSizeEnumTabloid    PageSizeEnum = "Tabloid"
)

type PdfConvertOptions 

type PdfConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Desired page width in pixels after conversion
	Width int32 `json:"Width,omitempty"`
	// Desired page height in pixels after conversion
	Height int32 `json:"Height,omitempty"`
	// Desired page DPI after conversion. The default resolution is: 96dpi
	Dpi int32 `json:"Dpi,omitempty"`
	// Set this property if you want to protect the converted document with a password
	Password string `json:"Password,omitempty"`
	// Desired page top margin in pixels after conversion
	MarginTop int32 `json:"MarginTop,omitempty"`
	// Desired page bottom margin in pixels after conversion
	MarginBottom int32 `json:"MarginBottom,omitempty"`
	// Desired page left margin in pixels after conversion
	MarginLeft int32 `json:"MarginLeft,omitempty"`
	// Desired page right margin in pixels after conversion
	MarginRight int32         `json:"MarginRight,omitempty"`
	PdfFormat   PdfFormatEnum `json:"PdfFormat,omitempty"`
	// Remove Pdf-A Compliance
	RemovePdfaCompliance bool `json:"RemovePdfaCompliance,omitempty"`
	// Specifies the zoom level in percentage. Default is 100.
	Zoom int32 `json:"Zoom,omitempty"`
	// Linearize PDF Document for the Web
	Linearize bool `json:"Linearize,omitempty"`
	// Link duplicate streams
	LinkDuplicateStreams bool `json:"LinkDuplicateStreams,omitempty"`
	// Remove unused objects
	RemoveUnusedObjects bool `json:"RemoveUnusedObjects,omitempty"`
	// Remove unused streams
	RemoveUnusedStreams bool `json:"RemoveUnusedStreams,omitempty"`
	// If CompressImages set to true, all images in the document are recompressed. The compression is defined by the ImageQuality property.
	CompressImages bool `json:"CompressImages,omitempty"`
	// Value in percent where 100% is unchanged quality and image size. To decrease the image size, use ImageQuality less than 100
	ImageQuality int32 `json:"ImageQuality,omitempty"`
	// Make fonts not embedded if set to true
	UnembedFonts bool `json:"UnembedFonts,omitempty"`
	// Convert a PDF from RGB colorspace to Grayscale
	Grayscale bool `json:"Grayscale,omitempty"`
	// Specify whether position of the document's window will be centered on the screen. Default: false.
	CenterWindow bool          `json:"CenterWindow,omitempty"`
	Direction    DirectionEnum `json:"Direction,omitempty"`
	// Specifying whether document's window title bar should display document title. Default: false.
	DisplayDocTitle bool `json:"DisplayDocTitle,omitempty"`
	// Specify whether document window must be resized to fit the first displayed page. Default: false.
	FitWindow bool `json:"FitWindow,omitempty"`
	// Specify whether menu bar should be hidden when document is active. Default: false.
	HideMenuBar bool `json:"HideMenuBar,omitempty"`
	// Specifying whether toolbar should be hidden when document is active. Default: false.
	HideToolBar bool `json:"HideToolBar,omitempty"`
	// Specify whether user interface elements should be hidden when document is active. Default: false.
	HideWindowUI          bool                      `json:"HideWindowUI,omitempty"`
	NonFullScreenPageMode NonFullScreenPageModeEnum `json:"NonFullScreenPageMode,omitempty"`
	PageLayout            PageLayoutEnum            `json:"PageLayout,omitempty"`
	PageMode              PageModeEnum              `json:"PageMode,omitempty"`
	Rotate                RotateEnum                `json:"Rotate,omitempty"`
	PageSize              PageSizeEnum              `json:"PageSize,omitempty"`
	PageOrientation       PageOrientationEnum       `json:"PageOrientation,omitempty"`
}

Options for to PDF conversion

type PdfFormatEnum added in v1.0.2 

type PdfFormatEnum string
const (
	PdfFormatEnumDefault PdfFormatEnum = "Default"
	PdfFormatEnumPdfA1A  PdfFormatEnum = "PdfA_1A"
	PdfFormatEnumPdfA1B  PdfFormatEnum = "PdfA_1B"
	PdfFormatEnumPdfA2A  PdfFormatEnum = "PdfA_2A"
	PdfFormatEnumPdfA3A  PdfFormatEnum = "PdfA_3A"
	PdfFormatEnumPdfA2B  PdfFormatEnum = "PdfA_2B"
	PdfFormatEnumPdfA2U  PdfFormatEnum = "PdfA_2U"
	PdfFormatEnumPdfA3B  PdfFormatEnum = "PdfA_3B"
	PdfFormatEnumPdfA3U  PdfFormatEnum = "PdfA_3U"
	PdfFormatEnumV13     PdfFormatEnum = "v1_3"
	PdfFormatEnumV14     PdfFormatEnum = "v1_4"
	PdfFormatEnumV15     PdfFormatEnum = "v1_5"
	PdfFormatEnumV16     PdfFormatEnum = "v1_6"
	PdfFormatEnumV17     PdfFormatEnum = "v1_7"
	PdfFormatEnumPdfX1A  PdfFormatEnum = "PdfX_1A"
	PdfFormatEnumPdfX3   PdfFormatEnum = "PdfX3"
)

type PdfLoadOptions 

type PdfLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Remove embedded files
	RemoveEmbeddedFiles bool `json:"RemoveEmbeddedFiles,omitempty"`
	// Set password to unprotect protected document
	Password string `json:"Password,omitempty"`
	// Hide annotations in Pdf documents
	HidePdfAnnotations bool `json:"HidePdfAnnotations,omitempty"`
	// Flatten all the fields of the PDF form
	FlattenAllFields bool `json:"FlattenAllFields,omitempty"`
}

Pdf document load options

type PdfRecognitionModeEnum added in v1.0.2 

type PdfRecognitionModeEnum string
const (
	PdfRecognitionModeEnumTextbox PdfRecognitionModeEnum = "Textbox"
	PdfRecognitionModeEnumFlow    PdfRecognitionModeEnum = "Flow"
)

type PdlConvertOptions 

type PdlConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
}

Page description langusge convert options

type PersonalStorageLoadOptions 

type PersonalStorageLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Folder which to be processed Default is Inbox
	Folder string `json:"Folder,omitempty"`
	// Controls how many levels in depth to perform conversion
	Depth int32 `json:"Depth,omitempty"`
}

Options for loading personal storage documents.

type PresentationConvertOptions 

type PresentationConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Set this property if you want to protect the converted document with a password
	Password string `json:"Password,omitempty"`
	// Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Powerpoint 2010. Starting from Microsoft Powerpoint 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.
	Zoom int32 `json:"Zoom,omitempty"`
}

Options for to presentation conversion

type PresentationLoadOptions 

type PresentationLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Default font for rendering the presentation. The following font will be used if a presentation font is missing.
	DefaultFont string `json:"DefaultFont,omitempty"`
	// Substitute specific fonts when converting Slides document.
	FontSubstitutes map[string]string `json:"FontSubstitutes,omitempty"`
	// Set password to unprotect protected document
	Password string `json:"Password,omitempty"`
	// Hide comments
	HideComments bool `json:"HideComments"`
	// Show hidden slides
	ShowHiddenSlides bool `json:"ShowHiddenSlides"`
}

Presentation document load options

type PsdConvertOptions 

type PsdConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Desired image width after conversion
	Width int32 `json:"Width,omitempty"`
	// Desired image height after conversion
	Height int32 `json:"Height,omitempty"`
	// Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96dpi
	HorizontalResolution int32 `json:"HorizontalResolution,omitempty"`
	// Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96dpi
	VerticalResolution int32 `json:"VerticalResolution,omitempty"`
	// Convert to grayscale image
	Grayscale bool `json:"Grayscale,omitempty"`
	// Image rotation angle
	RotateAngle int32 `json:"RotateAngle,omitempty"`
	// If true, the input firstly is converted to PDF and after that to desired format
	UsePdf bool `json:"UsePdf,omitempty"`
	// Adjust image brightness
	Brightness int32 `json:"Brightness,omitempty"`
	// Adjust image contrast
	Contrast int32 `json:"Contrast,omitempty"`
	// Adjust image gamma
	Gamma    float64      `json:"Gamma,omitempty"`
	FlipMode FlipModeEnum `json:"FlipMode,omitempty"`
	// Bits count per color channel
	ChannelBitsCount int32 `json:"ChannelBitsCount,omitempty"`
	// Color channels count
	ChannelsCount     int32                 `json:"ChannelsCount,omitempty"`
	ColorMode         ColorModeEnum         `json:"ColorMode,omitempty"`
	CompressionMethod CompressionMethodEnum `json:"CompressionMethod,omitempty"`
	// Psd file version
	Version int32 `json:"Version,omitempty"`
}

Psd convert options

type RotateEnum added in v1.0.2 

type RotateEnum string
const (
	RotateEnumNone  RotateEnum = "None"
	RotateEnumOn90  RotateEnum = "On90"
	RotateEnumOn180 RotateEnum = "On180"
	RotateEnumOn270 RotateEnum = "On270"
)

type RtfConvertOptions 

type RtfConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Desired page width after conversion
	Width int32 `json:"Width,omitempty"`
	// Desired page height after conversion
	Height int32 `json:"Height,omitempty"`
	// Desired page DPI after conversion. The default resolution is: 96dpi
	Dpi int32 `json:"Dpi,omitempty"`
	// Set this property if you want to protect the converted document with a password
	Password string `json:"Password,omitempty"`
	// Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.
	Zoom               int32                  `json:"Zoom,omitempty"`
	PdfRecognitionMode PdfRecognitionModeEnum `json:"PdfRecognitionMode,omitempty"`
	PageSize           PageSizeEnum           `json:"PageSize,omitempty"`
	PageOrientation    PageOrientationEnum    `json:"PageOrientation,omitempty"`
	// Specifies whether the keywords for \"old readers\" are written to RTF or not. This can significantly affect the size of the RTF document. Default is False.
	ExportImagesForOldReaders bool `json:"ExportImagesForOldReaders,omitempty"`
}

Rtf convert options

type SpreadsheetConvertOptions 

type SpreadsheetConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Set this property if you want to protect the converted document with a password
	Password string `json:"Password,omitempty"`
	// Specifies the zoom level in percentage. Default is 100.
	Zoom int32 `json:"Zoom,omitempty"`
	// If true, the input firstly is converted to PDF and after that to desired format
	UsePdf bool `json:"UsePdf,omitempty"`
}

Spreadsheet сonvert options class

type SpreadsheetLoadOptions 

type SpreadsheetLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Default font for Cells document. The following font will be used if a font is missing.
	DefaultFont string `json:"DefaultFont,omitempty"`
	// Substitute specific fonts when converting Cells document.
	FontSubstitutes map[string]string `json:"FontSubstitutes,omitempty"`
	// Show grid lines when converting Excel files
	ShowGridLines bool `json:"ShowGridLines"`
	// Show hidden sheets when converting Excel files
	ShowHiddenSheets bool `json:"ShowHiddenSheets"`
	// If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is true.
	OnePagePerSheet bool `json:"OnePagePerSheet"`
	// Convert specific range when converting to other than cells format. Example: \"D1:F8\"
	ConvertRange string `json:"ConvertRange,omitempty"`
	// Skips empty rows and columns when converting. Default is True.
	SkipEmptyRowsAndColumns bool `json:"SkipEmptyRowsAndColumns"`
	// Set password to unprotect protected document
	Password string `json:"Password,omitempty"`
	// Hide comments
	HideComments bool `json:"HideComments"`
}

Spreadsheet document load options

type StatusEnum added in v1.0.2 

type StatusEnum string
const (
	StatusEnumCreated  StatusEnum = "Created"
	StatusEnumStarted  StatusEnum = "Started"
	StatusEnumFailed   StatusEnum = "Failed"
	StatusEnumCanceled StatusEnum = "Canceled"
	StatusEnumFinished StatusEnum = "Finished"
)

type StorageExist 

type StorageExist struct {
	// Shows that the storage exists.
	Exists bool `json:"Exists"`
}

Storage exists

type StorageFile 

type StorageFile struct {
	// File or folder name.
	Name string `json:"Name,omitempty"`
	// True if it is a folder.
	IsFolder bool `json:"IsFolder"`
	// File or folder last modified DateTime.
	ModifiedDate time.Time `json:"ModifiedDate,omitempty"`
	// File or folder size.
	Size int64 `json:"Size"`
	// File or folder path.
	Path string `json:"Path,omitempty"`
}

File or folder information

type StoredConvertedResult 

type StoredConvertedResult struct {
	// Name of converted item
	Name string `json:"Name,omitempty"`
	// Size of converted item
	Size int64 `json:"Size"`
	// Path of resource file in storage
	Path string `json:"Path,omitempty"`
	// Uri in the storage of the converted item
	Url string `json:"Url,omitempty"`
}

Contains single converted item. Result is provided as url to a storage

type SupportedFormat 

type SupportedFormat struct {
	// Gets or sets source format
	SourceFormat string `json:"SourceFormat,omitempty"`
	// Gets or sets target formats
	TargetFormats []string `json:"TargetFormats,omitempty"`
}

Represents information about supported conversion for SourceFormat

type TiffConvertOptions 

type TiffConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Desired image width after conversion
	Width int32 `json:"Width,omitempty"`
	// Desired image height after conversion
	Height int32 `json:"Height,omitempty"`
	// Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96dpi
	HorizontalResolution int32 `json:"HorizontalResolution,omitempty"`
	// Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96dpi
	VerticalResolution int32 `json:"VerticalResolution,omitempty"`
	// Convert to grayscale image
	Grayscale bool `json:"Grayscale,omitempty"`
	// Image rotation angle
	RotateAngle int32 `json:"RotateAngle,omitempty"`
	// If true, the input firstly is converted to PDF and after that to desired format
	UsePdf bool `json:"UsePdf,omitempty"`
	// Adjust image brightness
	Brightness int32 `json:"Brightness,omitempty"`
	// Adjust image contrast
	Contrast int32 `json:"Contrast,omitempty"`
	// Adjust image gamma
	Gamma       float64         `json:"Gamma,omitempty"`
	FlipMode    FlipModeEnum    `json:"FlipMode,omitempty"`
	Compression CompressionEnum `json:"Compression,omitempty"`
}

Tiff convert options

type TrailingSpacesOptionsEnum added in v1.0.2 

type TrailingSpacesOptionsEnum string
const (
	TrailingSpacesOptionsEnumPreserve TrailingSpacesOptionsEnum = "Preserve"
	TrailingSpacesOptionsEnumTrim     TrailingSpacesOptionsEnum = "Trim"
)

type TxtConvertOptions 

type TxtConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
}

Txt convert options

type TxtLoadOptions 

type TxtLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Allows to specify how numbered list items are recognized when plain text document is converted. The default value is true.
	DetectNumberingWithWhitespaces bool                      `json:"DetectNumberingWithWhitespaces,omitempty"`
	TrailingSpacesOptions          TrailingSpacesOptionsEnum `json:"TrailingSpacesOptions,omitempty"`
	LeadingSpacesOptions           LeadingSpacesOptionsEnum  `json:"LeadingSpacesOptions,omitempty"`
	// Gets or sets the encoding that will be used when loading Txt document. Can be null. Default is null.
	Encoding string `json:"Encoding,omitempty"`
}

Txt document load options

type WatermarkOptions 

type WatermarkOptions struct {
	// Watermark text
	Text string `json:"Text,omitempty"`
	// Watermark font name if text watermark is applied
	FontName string `json:"FontName,omitempty"`
	// Watermark font name if text watermark is applied
	FontSize int32 `json:"FontSize,omitempty"`
	// Watermark font bold style if text watermark is applied
	Bold bool `json:"Bold,omitempty"`
	// Watermark font italic style if text watermark is applied
	Italic bool `json:"Italic,omitempty"`
	// Watermark font color if text watermark is applied
	Color string `json:"Color,omitempty"`
	// Watermark width
	Width int32 `json:"Width,omitempty"`
	// Watermark height
	Height int32 `json:"Height,omitempty"`
	// Watermark top position
	Top int32 `json:"Top,omitempty"`
	// Watermark left position
	Left int32 `json:"Left,omitempty"`
	// Watermark rotation angle
	RotationAngle int32 `json:"RotationAngle,omitempty"`
	// Watermark transparency. Value between 0 and 1. Value 0 is fully visible, value 1 is invisible.
	Transparency float64 `json:"Transparency,omitempty"`
	// Indicates that the watermark is stamped as background. If the value is true, the watermark is layed at the bottom. By default is false and the watermark is layed on top.
	Background bool `json:"Background,omitempty"`
	// Image watermark
	Image string `json:"Image,omitempty"`
	// Auto scale the watermark. If the value is true the font size and the position is automatically calculated to fit the page size.
	AutoAlign bool `json:"AutoAlign,omitempty"`
}

Options for settings watermark to the converted document

type WebConvertOptions 

type WebConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// If true, the input firstly is converted to PDF and after that to desired format
	UsePdf bool `json:"UsePdf,omitempty"`
	// If true fixed layout will be used e.g. absolutely positioned html elements Default:  true
	FixedLayout bool `json:"FixedLayout,omitempty"`
	// Show page borders when converting to fixed layout. Default is True
	FixedLayoutShowBorders bool `json:"FixedLayoutShowBorders,omitempty"`
	// Specifies the zoom level in percentage. Default is 100.
	Zoom int32 `json:"Zoom,omitempty"`
}

Options for to Html conversion

type WebLoadOptions 

type WebLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Enable or disable generation of page numbering in converted document. Default: false
	PageNumbering bool `json:"PageNumbering,omitempty"`
	// Use pdf for the conversion. Default: false
	UsePdf bool `json:"UsePdf,omitempty"`
	// Controls how HTML content is rendered. Default: AbsolutePositioning
	RenderingMode HtmlRenderingModeEnum `json:"RenderingMode,omitempty"`
}

Html document load options

type WebpConvertOptions 

type WebpConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Desired image width after conversion
	Width int32 `json:"Width,omitempty"`
	// Desired image height after conversion
	Height int32 `json:"Height,omitempty"`
	// Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96dpi
	HorizontalResolution int32 `json:"HorizontalResolution,omitempty"`
	// Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96dpi
	VerticalResolution int32 `json:"VerticalResolution,omitempty"`
	// Convert to grayscale image
	Grayscale bool `json:"Grayscale,omitempty"`
	// Image rotation angle
	RotateAngle int32 `json:"RotateAngle,omitempty"`
	// If true, the input firstly is converted to PDF and after that to desired format
	UsePdf bool `json:"UsePdf,omitempty"`
	// Adjust image brightness
	Brightness int32 `json:"Brightness,omitempty"`
	// Adjust image contrast
	Contrast int32 `json:"Contrast,omitempty"`
	// Adjust image gamma
	Gamma    float64      `json:"Gamma,omitempty"`
	FlipMode FlipModeEnum `json:"FlipMode"`
	// Indicates if the compression of the converted file will be lossless
	Lossless bool `json:"Lossless,omitempty"`
}

Webp convert options

type WordProcessingConvertOptions 

type WordProcessingConvertOptions struct {
	// Start conversion from FromPage page
	FromPage int32 `json:"FromPage,omitempty"`
	// Number of pages to convert
	PagesCount int32 `json:"PagesCount,omitempty"`
	// Convert specific pages. The list contains the page indexes of the pages to be converted
	Pages []int32 `json:"Pages,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Desired page width after conversion
	Width int32 `json:"Width,omitempty"`
	// Desired page height after conversion
	Height int32 `json:"Height,omitempty"`
	// Desired page DPI after conversion. The default resolution is: 96dpi
	Dpi int32 `json:"Dpi,omitempty"`
	// Set this property if you want to protect the converted document with a password
	Password string `json:"Password,omitempty"`
	// Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.
	Zoom               int32                  `json:"Zoom,omitempty"`
	PdfRecognitionMode PdfRecognitionModeEnum `json:"PdfRecognitionMode,omitempty"`
	PageSize           PageSizeEnum           `json:"PageSize,omitempty"`
	PageOrientation    PageOrientationEnum    `json:"PageOrientation,omitempty"`
}

Options for to word processing conversion

type WordProcessingLoadOptions 

type WordProcessingLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// Default font for Words document. The following font will be used if a font is missing.
	DefaultFont string `json:"DefaultFont,omitempty"`
	// If AutoFontSubstitution is disabled, GroupDocs.Conversion uses the DefaultFont for the substitution of missing fonts. If AutoFontSubstitution is enabled, GroupDocs.Conversion evaluates all the related fields in FontInfo (Panose, Sig etc) for the missing font and finds the closest match among the available font sources. Note that font substitution mechanism will override the DefaultFont in cases when FontInfo for the missing font is available in the document. The default value is True.
	AutoFontSubstitution bool `json:"AutoFontSubstitution"`
	// Substitute specific fonts when converting Words document.
	FontSubstitutes map[string]string `json:"FontSubstitutes,omitempty"`
	// Set password to unprotect protected document
	Password string `json:"Password,omitempty"`
	// Hide markup and track changes for Word documents
	HideWordTrackedChanges bool `json:"HideWordTrackedChanges"`
	// Hide comments
	HideComments bool `json:"HideComments"`
	// Specifies the default level in the document outline at which to display Word bookmarks. Default is 0. Valid range is 0 to 9.
	BookmarksOutlineLevel int32 `json:"BookmarksOutlineLevel,omitempty"`
	// Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the document outline. Default is 0. Valid range is 0 to 9.
	HeadingsOutlineLevels int32 `json:"HeadingsOutlineLevels,omitempty"`
	// Specifies how many levels in the document outline to show expanded when the file is viewed. Default is 0. Valid range is 0 to 9. Note that this options will not work when saving to XPS.
	ExpandedOutlineLevels int32 `json:"ExpandedOutlineLevels,omitempty"`
}

WordProcessing document load options

type XmlLoadOptions 

type XmlLoadOptions struct {
	// The format of input file, (\"docx\", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.
	Format string `json:"Format,omitempty"`
	// XSL document content to convert XML-FO using XSL
	XslFo string `json:"XslFo,omitempty"`
}

XML document load options

type XpsConvertOptions added in v1.0.2 

type XpsConvertOptions struct {
	// Desired page width in pixels after conversion
	Width int32 `json:"Width,omitempty"`
	// Desired page height in pixels after conversion
	Height int32 `json:"Height,omitempty"`
	// Desired page DPI after conversion. The default resolution is: 96dpi
	Dpi int32 `json:"Dpi,omitempty"`
	// Desired page top margin in pixels after conversion
	MarginTop int32 `json:"MarginTop,omitempty"`
	// Desired page bottom margin in pixels after conversion
	MarginBottom int32 `json:"MarginBottom,omitempty"`
	// Desired page left margin in pixels after conversion
	MarginLeft int32 `json:"MarginLeft,omitempty"`
	// Desired page right margin in pixels after conversion
	MarginRight int32 `json:"MarginRight,omitempty"`
	// Watermark specific options
	WatermarkOptions *WatermarkOptions `json:"WatermarkOptions,omitempty"`
	// Set this property if you want to protect the converted document with a password
	Password string `json:"Password,omitempty"`
	// If true, the input firstly is converted to PDF and after that to desired format
	UsePdf bool `json:"UsePdf,omitempty"`
}

Xps convert options

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.