ExportDocumentToDocxArgs Class

The parameter args to be used for exporting a document object to Word

Definition

Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
C#
public class ExportDocumentToDocxArgs : ComplexApiCallArgs
Inheritance
Object    ComplexApiCallArgs    ExportDocumentToDocxArgs

Constructors

ExportDocumentToDocxArgsInitializes a new instance of the ExportDocumentToDocxArgs class

Properties

CreateCoverPage if true, a cover page will be created and the following content is moved to the next page. [default: 'true']
CreateFooter if true, each page gets the current page number as footer. [default: 'true']
CreateHeader if true, each page gets the documents display name as header. [default: 'true']
CreateTableOfContents if true, a table of content is created. [default: 'true']
ExportCollapsed if false, only sections that are not collapsed get exported. Otherwise all sections are exported. [default: 'true']
ExportMarkup if true, the text markup will be used in the export as well. if false, only the plain text conversion will be used. [default: 'true']
ExportPreviewImages if true, the preview images are exported as inlined graphics. [default: 'true']
Filename the output filename to use (the name is not modified in any way, so a .docx extension should be used)
LogSourceName The "source" name that should be used when the action that receives the arguments wants to report Progress or other logging output. You will encounter this name as "aMessageSource" within you logging callback
(Inherited from ComplexApiCallArgs)
PageSize Selects either A4 or Letter page size.
Portrait if true, the word document gets portrait orientation, landscape otherwise. [default: 'true']

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Extension Methods

TraceError
(Defined by TraceHelper)
TraceInfo
(Defined by TraceHelper)
TraceWarning
(Defined by TraceHelper)

See Also