ExportToDocxArgs Class
Specialized argument class for the DOCX export
Definition
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
C#
public class ExportToDocxArgs : ExportObjectSelectionDataArgs- Inheritance
- Object ComplexApiCallArgs MdkExportDataArgs ExportDataArgs ExportObjectSelectionDataArgs ExportToDocxArgs
Constructors
| ExportToDocxArgs | Initializes a new instance of the ExportToDocxArgs class |
Properties
| ExporterName |
Fixes the name of that exporter to "DocxExport"
(Overrides MdkExportDataArgsExporterName) |
| ExportMethod | Determines how many documents are created an how they are structured. Defaults to "Single" |
| ExportQueries | Determines if calculated strips should be exported |
| Filename |
The fully qualified filename (or path name) of the export file that is to be written.
The Word export, for example, interprets this member as path name if you use the "one file per object" option.
(Inherited from ExportDataArgs) |
| GroupedBy | Determines in which way the objects are grouped. Defaults to "Folder" |
| HyperlinkOnReferences | When set to true hyperlinks (with the articy:// protocol) are created on objects that can be used to navigate to that object when the project is currently open in an articy:draft client and the protocol is installed properly. Defaults to true |
| IncludeImages | Determines if thumbnail images should be included in the document(s). Defaults to true |
| IncludeTechnicalNames | Set to true when the technical names of the objects included. Defaults to false |
| IncludeTitlePage | Set to true when a title page should be included. Defaults to true |
| InsertTableOfContents | Set to true when a table of contents should be included. Defaults to true |
| 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 | The page size for created document. Defaults to "A4" |
| PreselectedObjects |
A list of ObjectProxy instances describing the articy objects that shall be part of the export.
Usually you just pass the result of a call to SimpleFindObjects, SimpleFindConflicts or ResultSet.Rows to this parameter.
(Inherited from ExportObjectSelectionDataArgs) |
| SideBySideImages | Determines if a bigger version of location images should be placed side by side to the created document(s). Defaults to false |
| SortedBy | Determines how the groups are sorted. Defaults to "DisplayName" |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Extension Methods
| TraceError | (Defined by TraceHelper) |
| TraceInfo | (Defined by TraceHelper) |
| TraceWarning | (Defined by TraceHelper) |