Class OfficeToPDFOptions

Inheritance

System.Object

OptionsBase

ConversionOptions

OfficeToPDFOptions

Implements

System.IDisposable

Inherited Members

ConversionOptions.GetFileExtension()

ConversionOptions.SetFileExtension(String)

OptionsBase.mObjSet

OptionsBase.mDict

OptionsBase.ColorPtToNumber(ColorPt)

OptionsBase.ColorPtFromNumber(Double)

OptionsBase.GetArray(String)

OptionsBase.PutNumber(String, Double)

OptionsBase.PutBool(String, Boolean)

OptionsBase.PutText(String, String)

OptionsBase.PutRect(String, Rect)

OptionsBase.PushBackNumber(String, Double)

OptionsBase.PushBackBool(String, Boolean)

OptionsBase.PushBackText(String, String)

OptionsBase.PushBackRect(String, Rect)

OptionsBase.RectFromArray(Obj)

OptionsBase.insertRectCollection(String, RectCollection, Int32)

OptionsBase.GetInternalObj()

OptionsBase.Dispose()

OptionsBase.Dispose(Boolean)

OptionsBase.Destroy()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: pdftron.PDF

Assembly: PDFNetAndroid.dll

Syntax

public class OfficeToPDFOptions : ConversionOptions, IDisposable

Constructors

OfficeToPDFOptions()

Constructor.

Declaration

public OfficeToPDFOptions()

Methods

GetApplyPageBreaksToSheet()

Gets the value ApplyPageBreaksToSheet from the options object Whether we should split Excel workheets into pages so that the output resembles print output. If set to false (the default), Excel sheets will be placed one per page, except in the case where the sheets are very large

Declaration

public bool GetApplyPageBreaksToSheet()

Returns

Type	Description
System.Boolean	a bool, Whether we should split Excel workheets into pages so that the output resembles print output. If set to false (the default), Excel sheets will be placed one per page, except in the case where the sheets are very large.

GetDisplayChangeTracking()

Gets the value DisplayChangeTracking from the options object If this option is true, will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). Otherwise displays the resolved document content, with no markup. Defaults to true.

Declaration

public bool GetDisplayChangeTracking()

Returns

Type	Description
System.Boolean	a bool, If this option is true, will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). Otherwise displays the resolved document content, with no markup. Defaults to true..

GetExcelDefaultCellBorderWidth()

Gets the value ExcelDefaultCellBorderWidth from the options object Cell border width for table cells that would normally be drawn with no border. In units of points. Can be used to achieve a similar effect to the "show gridlines" display option within Microsoft Excel.

Declaration

public double GetExcelDefaultCellBorderWidth()

Returns

Type	Description
System.Double	a double, Cell border width for table cells that would normally be drawn with no border. In units of points. Can be used to achieve a similar effect to the "show gridlines" display option within Microsoft Excel..

GetExcelMaxAllowedCellCount()

Gets the value ExcelMaxAllowedCellCount from the options object Conversion will throw an exception if the number of cells in a Microsoft Excel document is above the set MaxAllowedCellCount. Used for early termination of resource intensive conversions. Setting this value to 250000 will allow the vast majority of Excel documents to convert without issue, while keeping RAM usage to a reasonable level. By default there is no limit to the number of allowed cells.

Declaration

public int GetExcelMaxAllowedCellCount()

Returns

Type

Description

System.Int32

a int, Conversion will throw an exception if the number of cells in a Microsoft Excel document is above the set MaxAllowedCellCount. Used for early termination of resource intensive conversions. Setting this value to 250000 will allow the vast majority of Excel documents to convert without issue, while keeping RAM usage to a reasonable level. By default there is no limit to the number of allowed cells..

GetHideTotalNumberOfPages()

Gets the value HideTotalNumberOfPages from the options object If the document has an element that displays the total number of pages and the total number of pages is unknown beforehand, remove those elements from the document.

Declaration

public bool GetHideTotalNumberOfPages()

Returns

Type	Description
System.Boolean	a bool, If the document has an element that displays the total number of pages and the total number of pages is unknown beforehand, remove those elements from the document..

GetLayoutResourcesPluginPath()

Gets the value LayoutResourcesPluginPath from the options object The path at which the pdftron-provided font resource plugin resides

Declaration

public string GetLayoutResourcesPluginPath()

Returns

Type	Description
System.String	a string, The path at which the pdftron-provided font resource plugin resides.

GetLocale()

Gets the value Locale from the options object ISO 639-1 code of the locale to be applied during conversion. For example: 'en-US', 'ar-SA', 'de-DE', etc. Currently only applied during xls/xlsx conversions.

Declaration

public string GetLocale()

Returns

Type	Description
System.String	a string, ISO 639-1 code of the locale to be applied during conversion. For example: 'en-US', 'ar-SA', 'de-DE', etc. Currently only applied during xls/xlsx conversions..

GetResourceDocPath()

Gets the value ResourceDocPath from the options object The path at which a .docx resource document resides

Declaration

public string GetResourceDocPath()

Returns

Type	Description
System.String	a string, The path at which a .docx resource document resides.

GetSmartSubstitutionPluginPath()

Gets the value SmartSubstitutionPluginPath from the options object The path at which the pdftron-provided font resource plugin resides

Declaration

public string GetSmartSubstitutionPluginPath()

Returns

Type	Description
System.String	a string, The path at which the pdftron-provided font resource plugin resides.

GetTemplateLeftDelimiter()

Gets the value TemplateLeftDelimiter from the options object Left delimiter for template tags. Defaults to '{{'.

Declaration

public string GetTemplateLeftDelimiter()

Returns

Type	Description
System.String	a string, Left delimiter for template tags. Defaults to '{{'..

GetTemplateParamsJson()

Gets the value TemplateParamsJson from the options object JSON string representing the data to be merged into a PDFTron office template. For a more featureful template API, see CreateOfficeTemplate.

Declaration

public string GetTemplateParamsJson()

Returns

Type	Description
System.String	a string, JSON string representing the data to be merged into a PDFTron office template. For a more featureful template API, see CreateOfficeTemplate..

GetTemplateRightDelimiter()

Gets the value TemplateRightDelimiter from the options object Right delimiter for template tags. Defaults to '}}'.

Declaration

public string GetTemplateRightDelimiter()

Returns

Type	Description
System.String	a string, Right delimiter for template tags. Defaults to '}}'..

GetTemplateStrictMode()

Gets the value TemplateStrictMode from the options object If "Strict Mode" is enabled, when a template key is missing from the json data an exception will be thrown. If "Strict Mode" is disabled (default), the tag will be replaced with no content.

Declaration

public bool GetTemplateStrictMode()

Returns

Type	Description
System.Boolean	a bool, If "Strict Mode" is enabled, when a template key is missing from the json data an exception will be thrown. If "Strict Mode" is disabled (default), the tag will be replaced with no content..

SetApplyPageBreaksToSheet(Boolean)

Sets the value for ApplyPageBreaksToSheet in the options object Whether we should split Excel workheets into pages so that the output resembles print output. If set to false (the default), Excel sheets will be placed one per page, except in the case where the sheets are very large

Declaration

public OfficeToPDFOptions SetApplyPageBreaksToSheet(bool apply_page_breaks)

Parameters

Type	Name	Description
System.Boolean	apply_page_breaks	Whether we should split Excel workheets into pages so that the output resembles print output. If set to false (the default), Excel sheets will be placed one per page, except in the case where the sheets are very large

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetDisplayChangeTracking(Boolean)

Sets the value for DisplayChangeTracking in the options object If this option is true, will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). Otherwise displays the resolved document content, with no markup. Defaults to true.

Declaration

public OfficeToPDFOptions SetDisplayChangeTracking(bool display_tracking)

Parameters

Type	Name	Description
System.Boolean	display_tracking	If this option is true, will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). Otherwise displays the resolved document content, with no markup. Defaults to true.

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetExcelDefaultCellBorderWidth(Double)

Sets the value for ExcelDefaultCellBorderWidth in the options object Cell border width for table cells that would normally be drawn with no border. In units of points. Can be used to achieve a similar effect to the "show gridlines" display option within Microsoft Excel.

Declaration

public OfficeToPDFOptions SetExcelDefaultCellBorderWidth(double width_in_points)

Parameters

Type	Name	Description
System.Double	width_in_points	Cell border width for table cells that would normally be drawn with no border. In units of points. Can be used to achieve a similar effect to the "show gridlines" display option within Microsoft Excel.

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetExcelMaxAllowedCellCount(Int32)

Sets the value for ExcelMaxAllowedCellCount in the options object Conversion will throw an exception if the number of cells in a Microsoft Excel document is above the set MaxAllowedCellCount. Used for early termination of resource intensive conversions. Setting this value to 250000 will allow the vast majority of Excel documents to convert without issue, while keeping RAM usage to a reasonable level. By default there is no limit to the number of allowed cells.

Declaration

public OfficeToPDFOptions SetExcelMaxAllowedCellCount(int max_cell_count)

Parameters

Type	Name	Description
System.Int32	max_cell_count	Conversion will throw an exception if the number of cells in a Microsoft Excel document is above the set MaxAllowedCellCount. Used for early termination of resource intensive conversions. Setting this value to 250000 will allow the vast majority of Excel documents to convert without issue, while keeping RAM usage to a reasonable level. By default there is no limit to the number of allowed cells.

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetHideTotalNumberOfPages(Boolean)

Sets the value for HideTotalNumberOfPages in the options object If the document has an element that displays the total number of pages and the total number of pages is unknown beforehand, remove those elements from the document.

Declaration

public OfficeToPDFOptions SetHideTotalNumberOfPages(bool hide_total_number_of_pages)

Parameters

Type	Name	Description
System.Boolean	hide_total_number_of_pages	If the document has an element that displays the total number of pages and the total number of pages is unknown beforehand, remove those elements from the document.

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetLayoutResourcesPluginPath(String)

Sets the value for LayoutResourcesPluginPath in the options object The path at which the pdftron-provided font resource plugin resides

Declaration

public OfficeToPDFOptions SetLayoutResourcesPluginPath(string resource_path)

Parameters

Type	Name	Description
System.String	resource_path	The path at which the pdftron-provided font resource plugin resides

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetLocale(String)

Sets the value for Locale in the options object ISO 639-1 code of the locale to be applied during conversion. For example: 'en-US', 'ar-SA', 'de-DE', etc. Currently only applied during xls/xlsx conversions.

Declaration

public OfficeToPDFOptions SetLocale(string locale_code)

Parameters

Type	Name	Description
System.String	locale_code	ISO 639-1 code of the locale to be applied during conversion. For example: 'en-US', 'ar-SA', 'de-DE', etc. Currently only applied during xls/xlsx conversions.

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetResourceDocPath(String)

Sets the value for ResourceDocPath in the options object The path at which a .docx resource document resides

Declaration

public OfficeToPDFOptions SetResourceDocPath(string resource_path)

Parameters

Type	Name	Description
System.String	resource_path	The path at which a .docx resource document resides

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetSmartSubstitutionPluginPath(String)

Sets the value for SmartSubstitutionPluginPath in the options object The path at which the pdftron-provided font resource plugin resides

Declaration

public OfficeToPDFOptions SetSmartSubstitutionPluginPath(string plugin_path)

Parameters

Type	Name	Description
System.String	plugin_path	The path at which the pdftron-provided font resource plugin resides

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetTemplateLeftDelimiter(String)

Sets the value for TemplateLeftDelimiter in the options object Left delimiter for template tags. Defaults to '{{'.

Declaration

public OfficeToPDFOptions SetTemplateLeftDelimiter(string delim)

Parameters

Type	Name	Description
System.String	delim	Left delimiter for template tags. Defaults to '{{'.

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetTemplateParamsJson(String)

Sets the value for TemplateParamsJson in the options object JSON string representing the data to be merged into a PDFTron office template. For a more featureful template API, see CreateOfficeTemplate.

Declaration

public OfficeToPDFOptions SetTemplateParamsJson(string json_params)

Parameters

Type	Name	Description
System.String	json_params	JSON string representing the data to be merged into a PDFTron office template. For a more featureful template API, see CreateOfficeTemplate.

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetTemplateRightDelimiter(String)

Sets the value for TemplateRightDelimiter in the options object Right delimiter for template tags. Defaults to '}}'.

Declaration

public OfficeToPDFOptions SetTemplateRightDelimiter(string delim)

Parameters

Type	Name	Description
System.String	delim	Right delimiter for template tags. Defaults to '}}'.

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

SetTemplateStrictMode(Boolean)

Sets the value for TemplateStrictMode in the options object If "Strict Mode" is enabled, when a template key is missing from the json data an exception will be thrown. If "Strict Mode" is disabled (default), the tag will be replaced with no content.

Declaration

public OfficeToPDFOptions SetTemplateStrictMode(bool strict_mode)

Parameters

Type	Name	Description
System.Boolean	strict_mode	If "Strict Mode" is enabled, when a template key is missing from the json data an exception will be thrown. If "Strict Mode" is disabled (default), the tag will be replaced with no content.

Returns

Type	Description
OfficeToPDFOptions	this object, for call chaining

Implements

System.IDisposable