- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OfficeToPDFOptions.h
Go to the documentation of this file.
1 // This file is autogenerated: please see the codegen template "Options"
2 #ifndef PDFTRON_H_CPPPDFOfficeToPDFOptions
3 #define PDFTRON_H_CPPPDFOfficeToPDFOptions
4
5 #include <PDF/ConversionOptions.h>
6
7 namespace pdftron{ namespace PDF{
8
9 class OfficeToPDFOptions : public ConversionOptions
10 {
11 public:
15 enum StructureTagLevel
16 {
17 e_default = 0,
18 e_none = 1
19 };
20
24 enum DisplayComments
25 {
26 e_off = 0,
27 e_annotations = 1
28 };
29
33 enum DisplaySpeakerNotes
34 {
35 e_no_speaker_notes = 0,
36 e_speaker_notes_annotations = 1
37 };
38
44 enum UpdateDynamicFields
45 {
46 e_update_all = -1,
47 e_update_none = 0,
48 e_update_doc_props = 1
49 };
50
54 enum AnimationMode
55 {
56 e_ignore = 0,
57 e_paginate = 1
58 };
59
60 OfficeToPDFOptions();
61 ~OfficeToPDFOptions();
62
63
71 AnimationMode GetAnimationHandling();
72
81 OfficeToPDFOptions& SetAnimationHandling(AnimationMode value);
82
83
92 bool GetApplyPageBreaksToSheet();
93
103 OfficeToPDFOptions& SetApplyPageBreaksToSheet(bool value);
104
105
113 bool GetDisableExcelHeadersFooters();
114
123 OfficeToPDFOptions& SetDisableExcelHeadersFooters(bool value);
124
125
132 bool GetDisableExcelMargins();
133
141 OfficeToPDFOptions& SetDisableExcelMargins(bool value);
142
143
152 bool GetDisableSheetHeightLimit();
153
163 OfficeToPDFOptions& SetDisableSheetHeightLimit(bool value);
164
165
174 bool GetDisplayChangeTracking();
175
185 OfficeToPDFOptions& SetDisplayChangeTracking(bool value);
186
187
194 DisplayComments GetDisplayComments();
195
203 OfficeToPDFOptions& SetDisplayComments(DisplayComments value);
204
205
213 bool GetDisplayHiddenCells();
214
223 OfficeToPDFOptions& SetDisplayHiddenCells(bool value);
224
225
233 bool GetDisplayHiddenText();
234
243 OfficeToPDFOptions& SetDisplayHiddenText(bool value);
244
245
252 DisplaySpeakerNotes GetDisplaySpeakerNotes();
253
261 OfficeToPDFOptions& SetDisplaySpeakerNotes(DisplaySpeakerNotes value);
262
263
271 double GetExcelDefaultCellBorderWidth();
272
281 OfficeToPDFOptions& SetExcelDefaultCellBorderWidth(double value);
282
283
294 UInt32 GetExcelMaxAllowedCellCount();
295
307 OfficeToPDFOptions& SetExcelMaxAllowedCellCount(UInt32 value);
308
309
317 bool GetHideTotalNumberOfPages();
318
327 OfficeToPDFOptions& SetHideTotalNumberOfPages(bool value);
328
329
339 bool GetIncludeBookmarks();
340
351 OfficeToPDFOptions& SetIncludeBookmarks(bool value);
352
353
366 bool GetIncrementalSave();
367
381 OfficeToPDFOptions& SetIncrementalSave(bool value);
382
383
389 UString GetLayoutResourcesPluginPath();
390
397 OfficeToPDFOptions& SetLayoutResourcesPluginPath(const UString& value);
398
399
407 UString GetLocale();
408
417 OfficeToPDFOptions& SetLocale(const UString& value);
418
419
425 UString GetPassword();
426
433 OfficeToPDFOptions& SetPassword(const UString& value);
434
435
441 UString GetResourceDocPath();
442
449 OfficeToPDFOptions& SetResourceDocPath(const UString& value);
450
451
457 UString GetSmartSubstitutionPluginPath();
458
465 OfficeToPDFOptions& SetSmartSubstitutionPluginPath(const UString& value);
466
467
474 bool GetShowExcelGridlines();
475
483 OfficeToPDFOptions& SetShowExcelGridlines(bool value);
484
485
492 StructureTagLevel GetStructureTagLevel();
493
501 OfficeToPDFOptions& SetStructureTagLevel(StructureTagLevel value);
502
503
509 UString GetTemplateLeftDelimiter();
510
517 OfficeToPDFOptions& SetTemplateLeftDelimiter(const UString& value);
518
519
527 UString GetTemplateParamsJson();
528
537 OfficeToPDFOptions& SetTemplateParamsJson(const UString& value);
538
539
545 UString GetTemplateRightDelimiter();
546
553 OfficeToPDFOptions& SetTemplateRightDelimiter(const UString& value);
554
555
563 bool GetTemplateStrictMode();
564
573 OfficeToPDFOptions& SetTemplateStrictMode(bool value);
574
575
588 UpdateDynamicFields GetUpdateDynamicFields();
589
603 OfficeToPDFOptions& SetUpdateDynamicFields(UpdateDynamicFields value);
604
605
614 bool GetUpdateTableOfContents();
615
625 OfficeToPDFOptions& SetUpdateTableOfContents(bool value);
626
627
628 };
629
630 }
631 }
632
633 #include "../Impl/OfficeToPDFOptions.inl"
634 #endif // PDFTRON_H_CPPPDFOfficeToPDFOptions
pdftron::PDF::OfficeToPDFOptions::GetTemplateParamsJson
UString GetTemplateParamsJson()
pdftron::PDF::OfficeToPDFOptions::GetIncrementalSave
bool GetIncrementalSave()
pdftron::PDF::OfficeToPDFOptions::SetDisplaySpeakerNotes
OfficeToPDFOptions & SetDisplaySpeakerNotes(DisplaySpeakerNotes value)
pdftron::PDF::OfficeToPDFOptions::e_none
No structure tags. This can be used to get smaller file sizes.
Definition: OfficeToPDFOptions.h:18
pdftron::PDF::OfficeToPDFOptions::GetIncludeBookmarks
bool GetIncludeBookmarks()
pdftron::PDF::OfficeToPDFOptions::GetUpdateTableOfContents
bool GetUpdateTableOfContents()
pdftron::PDF::OfficeToPDFOptions::GetDisplayHiddenCells
bool GetDisplayHiddenCells()
pdftron::PDF::OfficeToPDFOptions::GetExcelDefaultCellBorderWidth
double GetExcelDefaultCellBorderWidth()
pdftron::PDF::OfficeToPDFOptions::e_paginate
Follows PowerPoint&#39;s presentation mode where each click through the presentation will be generated as...
Definition: OfficeToPDFOptions.h:57
pdftron::PDF::OfficeToPDFOptions::GetApplyPageBreaksToSheet
bool GetApplyPageBreaksToSheet()
pdftron::PDF::OfficeToPDFOptions::SetDisableExcelHeadersFooters
OfficeToPDFOptions & SetDisableExcelHeadersFooters(bool value)
pdftron::PDF::OfficeToPDFOptions::SetAnimationHandling
OfficeToPDFOptions & SetAnimationHandling(AnimationMode value)
pdftron::PDF::OfficeToPDFOptions::SetLocale
OfficeToPDFOptions & SetLocale(const UString &value)
pdftron::PDF::OfficeToPDFOptions::SetShowExcelGridlines
OfficeToPDFOptions & SetShowExcelGridlines(bool value)
ConversionOptions.h
pdftron::PDF::OfficeToPDFOptions::SetHideTotalNumberOfPages
OfficeToPDFOptions & SetHideTotalNumberOfPages(bool value)
pdftron::PDF::OfficeToPDFOptions::SetPassword
OfficeToPDFOptions & SetPassword(const UString &value)
pdftron::PDF::OfficeToPDFOptions::~OfficeToPDFOptions
~OfficeToPDFOptions()
pdftron::PDF::OfficeToPDFOptions::DisplaySpeakerNotes
DisplaySpeakerNotes
Definition: OfficeToPDFOptions.h:33
pdftron::PDF::OfficeToPDFOptions::GetDisplayChangeTracking
bool GetDisplayChangeTracking()
pdftron::PDF::OfficeToPDFOptions::e_off
Default value. Display no comments.
Definition: OfficeToPDFOptions.h:26
pdftron::PDF::OfficeToPDFOptions::SetDisplayHiddenText
OfficeToPDFOptions & SetDisplayHiddenText(bool value)
pdftron::PDF::OfficeToPDFOptions::GetDisableExcelHeadersFooters
bool GetDisableExcelHeadersFooters()
pdftron::PDF::OfficeToPDFOptions::SetLayoutResourcesPluginPath
OfficeToPDFOptions & SetLayoutResourcesPluginPath(const UString &value)
pdftron::PDF::OfficeToPDFOptions::AnimationMode
AnimationMode
Definition: OfficeToPDFOptions.h:54
pdftron::PDF::OfficeToPDFOptions::SetDisplayChangeTracking
OfficeToPDFOptions & SetDisplayChangeTracking(bool value)
pdftron::PDF::OfficeToPDFOptions::GetDisableExcelMargins
bool GetDisableExcelMargins()
pdftron::PDF::OfficeToPDFOptions::e_no_speaker_notes
Default value. Display no speaker notes.
Definition: OfficeToPDFOptions.h:35
pdftron::PDF::OfficeToPDFOptions::SetApplyPageBreaksToSheet
OfficeToPDFOptions & SetApplyPageBreaksToSheet(bool value)
pdftron::PDF::OfficeToPDFOptions::e_update_none
Default value. Does not update dynamic fields within the document.
Definition: OfficeToPDFOptions.h:47
pdftron::PDF::OfficeToPDFOptions::OfficeToPDFOptions
OfficeToPDFOptions()
pdftron::PDF::OfficeToPDFOptions::GetAnimationHandling
AnimationMode GetAnimationHandling()
pdftron::PDF::OfficeToPDFOptions::e_annotations
Display comments as annotations.
Definition: OfficeToPDFOptions.h:27
pdftron::PDF::OfficeToPDFOptions::SetTemplateParamsJson
OfficeToPDFOptions & SetTemplateParamsJson(const UString &value)
pdftron::PDF::OfficeToPDFOptions::GetResourceDocPath
UString GetResourceDocPath()
pdftron::PDF::OfficeToPDFOptions::SetDisplayComments
OfficeToPDFOptions & SetDisplayComments(DisplayComments value)
pdftron::PDF::OfficeToPDFOptions::GetTemplateLeftDelimiter
UString GetTemplateLeftDelimiter()
pdftron::PDF::OfficeToPDFOptions::e_update_all
Updates all dynamic fields within the document.
Definition: OfficeToPDFOptions.h:46
pdftron::PDF::OfficeToPDFOptions::SetSmartSubstitutionPluginPath
OfficeToPDFOptions & SetSmartSubstitutionPluginPath(const UString &value)
pdftron::PDF::OfficeToPDFOptions
Definition: OfficeToPDFOptions.h:9
pdftron::UInt32
TRN_UInt32 UInt32
Definition: BasicTypes.h:13
pdftron::PDF::OfficeToPDFOptions::GetDisplayHiddenText
bool GetDisplayHiddenText()
pdftron::PDF::OfficeToPDFOptions::e_speaker_notes_annotations
Display speaker notes as annotations.
Definition: OfficeToPDFOptions.h:36
pdftron::PDF::OfficeToPDFOptions::SetExcelDefaultCellBorderWidth
OfficeToPDFOptions & SetExcelDefaultCellBorderWidth(double value)
pdftron::PDF::OfficeToPDFOptions::GetStructureTagLevel
StructureTagLevel GetStructureTagLevel()
pdftron::PDF::OfficeToPDFOptions::GetExcelMaxAllowedCellCount
UInt32 GetExcelMaxAllowedCellCount()
pdftron::PDF::OfficeToPDFOptions::GetUpdateDynamicFields
UpdateDynamicFields GetUpdateDynamicFields()
pdftron::PDF::OfficeToPDFOptions::GetLocale
UString GetLocale()
pdftron::PDF::OfficeToPDFOptions::e_default
Default level of structure tags, good for accessibility.
Definition: OfficeToPDFOptions.h:17
pdftron::PDF::OfficeToPDFOptions::GetDisplaySpeakerNotes
DisplaySpeakerNotes GetDisplaySpeakerNotes()
pdftron::PDF::OfficeToPDFOptions::GetTemplateStrictMode
bool GetTemplateStrictMode()
pdftron::PDF::OfficeToPDFOptions::SetResourceDocPath
OfficeToPDFOptions & SetResourceDocPath(const UString &value)
pdftron::PDF::OfficeToPDFOptions::GetTemplateRightDelimiter
UString GetTemplateRightDelimiter()
pdftron::PDF::OfficeToPDFOptions::GetDisplayComments
DisplayComments GetDisplayComments()
pdftron::PDF::OfficeToPDFOptions::SetExcelMaxAllowedCellCount
OfficeToPDFOptions & SetExcelMaxAllowedCellCount(UInt32 value)
pdftron::PDF::OfficeToPDFOptions::SetUpdateTableOfContents
OfficeToPDFOptions & SetUpdateTableOfContents(bool value)
pdftron::PDF::OfficeToPDFOptions::e_ignore
Default value. Displays the default (preview) slide layout and ignores any animations. The number of generated pages is equal to the number of slides.
Definition: OfficeToPDFOptions.h:56
pdftron::PDF::OfficeToPDFOptions::GetPassword
UString GetPassword()
pdftron::PDF::OfficeToPDFOptions::SetTemplateStrictMode
OfficeToPDFOptions & SetTemplateStrictMode(bool value)
pdftron::PDF::OfficeToPDFOptions::DisplayComments
DisplayComments
Definition: OfficeToPDFOptions.h:24
pdftron::PDF::OfficeToPDFOptions::GetLayoutResourcesPluginPath
UString GetLayoutResourcesPluginPath()
pdftron::PDF::OfficeToPDFOptions::UpdateDynamicFields
UpdateDynamicFields
Definition: OfficeToPDFOptions.h:44
pdftron::PDF::OfficeToPDFOptions::SetIncrementalSave
OfficeToPDFOptions & SetIncrementalSave(bool value)
pdftron::PDF::OfficeToPDFOptions::StructureTagLevel
StructureTagLevel
Definition: OfficeToPDFOptions.h:15
pdftron::PDF::OfficeToPDFOptions::SetIncludeBookmarks
OfficeToPDFOptions & SetIncludeBookmarks(bool value)
pdftron::PDF::OfficeToPDFOptions::GetDisableSheetHeightLimit
bool GetDisableSheetHeightLimit()
pdftron::PDF::OfficeToPDFOptions::GetHideTotalNumberOfPages
bool GetHideTotalNumberOfPages()
pdftron::PDF::OfficeToPDFOptions::SetUpdateDynamicFields
OfficeToPDFOptions & SetUpdateDynamicFields(UpdateDynamicFields value)
pdftron::PDF::OfficeToPDFOptions::SetStructureTagLevel
OfficeToPDFOptions & SetStructureTagLevel(StructureTagLevel value)
pdftron::PDF::OfficeToPDFOptions::GetSmartSubstitutionPluginPath
UString GetSmartSubstitutionPluginPath()
pdftron::PDF::OfficeToPDFOptions::SetTemplateLeftDelimiter
OfficeToPDFOptions & SetTemplateLeftDelimiter(const UString &value)
pdftron::UString
Definition: UString.h:27
pdftron::PDF::OfficeToPDFOptions::SetDisableSheetHeightLimit
OfficeToPDFOptions & SetDisableSheetHeightLimit(bool value)
pdftron::PDF::OfficeToPDFOptions::e_update_doc_props
Updates document property fields within the document.
Definition: OfficeToPDFOptions.h:48
pdftron::PDF::OfficeToPDFOptions::GetShowExcelGridlines
bool GetShowExcelGridlines()
pdftron::PDF::OfficeToPDFOptions::SetDisableExcelMargins
OfficeToPDFOptions & SetDisableExcelMargins(bool value)
pdftron::PDF::OfficeToPDFOptions::SetTemplateRightDelimiter
OfficeToPDFOptions & SetTemplateRightDelimiter(const UString &value)
pdftron::PDF::OfficeToPDFOptions::SetDisplayHiddenCells
OfficeToPDFOptions & SetDisplayHiddenCells(bool value)