Foxit PDF SDK

fs_ofddoc.h
1 #ifndef FS_OFD_DOC_H_
2 #define FS_OFD_DOC_H_
3
4 #include "common/fs_common.h"
5 #include "common/fs_image.h"
6
12 namespace foxit {
13 namespace fld {
14 class FLDDoc;
15 }
19 namespace ofd {
20 class OFDPage;
21 class OFDTemplatePage;
22 class Catalog;
23 class Bookmarks;
24 class CustomTags;
25 class TagTreeNode;
26 class Outline;
27 class Attachments;
28 class Attachment;
29 class OFDPermission;
30 class Annots;
34 namespace ofdseal {
35 class Signature;
36 }
37
39 class PageNumberParameter FS_FINAL : public Object {
40 public:
46 typedef enum _PageNumberLocationType {
48 e_PageNumberLocationTypeLeftTop = 0,
50 e_PageNumberLocationTypeTopMiddle = 1,
52 e_PageNumberLocationTypeRightTop = 2,
54 e_PageNumberLocationTypeLeftBottom = 3,
56 e_PageNumberLocationTypeBottomMiddle = 4,
58 e_PageNumberLocationTypeRightBottom = 5
59 } PageNumberLocationType;
60
66 typedef enum _PageNumberMarginType {
68 e_PageNumberMarginTypeSmall = 0,
70 e_PageNumberMarginTypeNormal = 1,
72 e_PageNumberMarginTypeLarge = 2
73 } PageNumberMarginType;
74
75
79 PageNumberParameter() :
80 location(PageNumberParameter::e_PageNumberLocationTypeLeftTop),
81 font_name(L"宋体"),
82 font_size(12),
83 text_color(0),
84 start_page(0),
85 end_page(0),
86 is_first_page_cover(false),
87 first_page_number(1),
88 is_folio(false),
89 margin(PageNumberParameter::e_PageNumberMarginTypeNormal),
90 skip_blank_page(false) {}
91
115 explicit PageNumberParameter(PageNumberLocationType location, const WString& font_name, float font_size, foxit::RGB text_color, int start_page,
116 int end_page, bool is_first_page_cover, int first_page_number, bool is_folio, PageNumberMarginType margin, bool skip_blank_page) :
117 location(location),
118 font_name(font_name),
119 font_size(font_size),
120 text_color(text_color),
121 start_page(start_page),
122 end_page(end_page),
123 is_first_page_cover(is_first_page_cover),
124 first_page_number(first_page_number),
125 is_folio(is_folio),
126 margin(margin),
127 skip_blank_page(skip_blank_page) {}
128
134 PageNumberParameter(const PageNumberParameter& other) {
135 this->location = other.location;
136 this->font_name = other.font_name;
137 this->font_size = other.font_size;
138 this->text_color = other.text_color;
139 this->start_page = other.start_page;
140 this->end_page = other.end_page;
141 this->is_first_page_cover = other.is_first_page_cover;
142 this->first_page_number = other.first_page_number;
143 this->is_folio = other.is_folio;
144 this->margin = other.margin;
145 this->skip_blank_page = other.skip_blank_page;
146 }
147
155 PageNumberParameter& operator = (const PageNumberParameter& other) {
156 this->location = other.location;
157 this->font_name = other.font_name;
158 this->font_size = other.font_size;
159 this->text_color = other.text_color;
160 this->start_page = other.start_page;
161 this->end_page = other.end_page;
162 this->is_first_page_cover = other.is_first_page_cover;
163 this->first_page_number = other.first_page_number;
164 this->is_folio = other.is_folio;
165 this->margin = other.margin;
166 this->skip_blank_page = other.skip_blank_page;
167 return *this;
168 }
169
193 void Set(PageNumberLocationType location, const WString& font_name, float font_size, foxit::RGB text_color, int start_page,
194 int end_page, bool is_first_page_cover, int first_page_number, bool is_folio, PageNumberMarginType margin, bool skip_blank_page) {
195 this->location = location;
196 this->font_name = font_name;
197 this->font_size = font_size;
198 this->text_color = text_color;
199 this->start_page = start_page;
200 this->end_page = end_page;
201 this->is_first_page_cover = is_first_page_cover;
202 this->first_page_number = first_page_number;
203 this->is_folio = is_folio;
204 this->margin = margin;
205 this->skip_blank_page = skip_blank_page;
206 }
207
214 PageNumberLocationType location;
215
219 WString font_name;
220
224 float font_size;
225
229 foxit::RGB text_color;
230
234 int start_page;
235
239 int end_page;
240
244 bool is_first_page_cover;
245
249 int first_page_number;
250
254 bool is_folio;
255
262 PageNumberMarginType margin;
263
267 bool skip_blank_page;
268 };
269
271 class OFDDoc FS_FINAL : public Base {
272 public:
278 typedef enum _EncryptMethod {
280 e_OFDEncryptMethodNone = 0,
282 e_OFDEncryptMethodPwd = 1,
284 e_OFDEncryptMethodCert = 2
285 } EncryptMethod;
286
292 typedef enum _EncryptType {
294 e_OFDEncryptTypeNone = 0,
296 e_OFDEncryptTypeRC4 = 1,
298 e_OFDEncryptTypeAES128 = 2,
300 e_OFDEncryptTypeAES256 = 3,
302 e_OFDEncryptTypeSM4 = 4
303 } EncryptType;
304
310 typedef enum _ResourceType {
312 e_OFDResourceTypeUnknown = 0,
314 e_OFDResourceTypeColorSpace = 1,
316 e_OFDResourceTypeDrawParam = 2,
318 e_OFDResourceTypeFont = 3,
320 e_OFDResourceTypeMultimedia = 4,
322 e_OFDResourceTypeCompositeGraphicUnit = 5
323 } ResourceType;
324
325
331 explicit OFDDoc(const foxit::fld::FLDDoc& doc);
332
334 ~OFDDoc();
335
341 OFDDoc(const OFDDoc& other);
342
350 OFDDoc& operator = (const OFDDoc& other);
351
359 bool operator == (const OFDDoc& other) const;
360
368 bool operator != (const OFDDoc& other) const;
369
377 bool IsEmpty() const;
378
384 int GetPageCount();
385
394 OFDPage GetPage(int index);
395
403 OFDPage GetPageByID(foxit::uint32 id);
404
410 OFDPage AddPage();
411
420 OFDPage InsertPage(int index);
421
430 void RemovePage(int index);
431
440 void ReservedPage(int index);
441
452 bool MovePage(int index, int dest_index);
453
459 int GetTemplatePageCount();
460
469 OFDTemplatePage GetTemplatePage(int index);
470
478 OFDTemplatePage GetTemplatePageByID(int id);
479
487 OFDTemplatePage GetTemplatePageByName(const String& name);
488
497 OFDTemplatePage InsertTemplatePage(int index);
498
507 void RemoveTemplatePage(int index);
508
514 void RemoveAllTemplatePages();
515
521 OFDTemplatePage AddTemplatePage();
522
530 OFDTemplatePage AddTemplatePageFromPage(OFDPage page);
531
543 OFDPage AddPageFromTemplatePage(int index, int dest_index = -1);
544
550 Attachments CreateAttachments();
551
557 Attachments GetAttachments();
558
564 int GetAttachmentCount();
565
574 Attachment GetAttachment(int index);
575
583 Attachment GetAttachmentByName(const String& name);
584
593 String GetAttachmentBuffer(int index);
594
603 foxit::common::file::ReaderCallback* GetAttachmentFile(int index);
604
614 void ExportAttachment(int index, const String& file_path);
615
625 void ExportAttachment(int index, const WString& file_path);
626
636 void ExportAttachment(int index, foxit::common::file::WriterCallback* file_writer);
637
647 Attachment AddAttachment(const String& file_name, const String& name = NULL, const String& usage = NULL);
648
658 Attachment AddAttachment(const WString& file_name, const String& name = NULL, const String& usage = NULL);
659
665 int GetXmlFileAttachmentCount();
666
676 bool SaveXmlFileAttachment(int index, const String& file_path);
677
687 bool SaveXmlFileAttachment(int index, const WString& file_path);
688
696 WString GetMetadata(const WString& key);
697
706 void SetMetadata(const WString& key, const WString& value);
707
713 int GetKeywordCount();
714
723 void InsertKeyword(const WString& keyword, int index = -1);
724
733 void RemoveKeyword(int index);
734
740 int GetCustomDataCount();
741
750 WString GetCustomDataName(int index);
751
760 WString GetCustomDataValue(int index);
761
770 void AddCustomData(const String& key, const String& value);
771
781 void InsertCustomData(const String& key, const String& value, int index);
782
791 void RemoveCustomData(int index);
792
800 foxit::uint32 AddResourceFromFile(const String& file_path, const String& format);
801
810 foxit::uint32 AddResourceFromFile(const WString& file_path, const String& format);
811
819 foxit::uint32 AddImageResourceFromFile(const String& file_path);
820
828 foxit::uint32 AddImageResourceFromFile(const WString& file_path);
829
840 foxit::uint32 AddImageResourceFromBuffer(const String& buffer, foxit::common::Image::Type format);
841
850 foxit::uint32 AddFontResourceFromName(const String& font_family, const String& font_name);
851
860 ResourceType GetResourceTypeByID(foxit::uint32 res_id);
861
869 foxit::common::file::ReaderCallback* GetMultiMediaFileByID(int res_id);
870
879 void ExportMultiMediaByID(foxit::uint32 res_id, const String& file_path);
880
889 void ExportMultiMediaByID(foxit::uint32 res_id, const WString& file_path);
890
899 void ExportMultiMediaByID(foxit::uint32 res_id, foxit::common::file::WriterCallback* file_writer);
900
908 String GetMultiMediaBufferByID(foxit::uint32 res_id);
909
917 WString GetMultiMediaFileNameByID(foxit::uint32 res_id);
918
926 WString GetMultiMediaTypeByID(foxit::uint32 res_id);
927
935 WString GetMultiMediaFormatByID(foxit::uint32 res_id);
936
944 void ExportAnnots(const String& file_path);
945
957 void ExportAnnots(int start_index, int end_index, const String& file_path);
958
966 void ImportAnnots(const String& file_path);
967
975 void AddPageNumber(const PageNumberParameter& param);
976
986 bool InsertDocument(const OFDDoc& other, int dest_index = -1);
987
993 Outline CreateOutline();
994
1000 Outline GetOutline();
1001
1007 bool RemoveOutline();
1008
1016 bool AddCatalog(const Catalog& catalog);
1017
1023 int GetSignatureCount();
1024
1033 ofdseal::Signature GetSignature(int index);
1034
1040 Bookmarks CreateBookmarks();
1041
1047 Bookmarks GetBookmarks();
1048
1054 CustomTags CreateCustomTags();
1055
1061 CustomTags GetCustomTags();
1062
1070 TagTreeNode GetTagTreeRoot(const String& type);
1071
1083 void InitializeTagTreeNode(const String& type, const String& name_space, const String& name, const String& file_extension, bool key_unique);
1084
1092 void InitializeCertTagTreeNode(bool key_unique);
1093
1101 void BeginTagTreeNode(const String& key_path);
1102
1111 void AddTagTreeNodeMetaData(const String& key, const String& value);
1112
1120 void EndTagTreeNode(const String& key_path);
1121
1127 void ClearTagTreeNode();
1128
1136 bool ExportOfficeDoc(const String& file_path);
1137
1145 bool ExportOfficeDoc(const WString& file_path);
1146
1152 bool RestoreOriginalDocument();
1153
1161 bool RefreshObjectsPermission(bool authenticated);
1162
1174 bool CustomEncrypt(const String& security_type, const String& crypto_type, int key_length, const String& user_password, const String& owner_password);
1175
1183 bool RemoveEncryption(const String& owner_password);
1184
1190 OFDPermission GetPermissions();
1191
1197 OFDPermission CreatePermissions();
1198
1207 void EmbedFont(const String& font_name);
1208
1214 int GetVersionCount();
1215
1224 void SetCurrentVersion(int index);
1225
1231 void CreateVersion();
1232
1233 explicit OFDDoc(FS_HANDLE handle = NULL);
1234 };
1235
1236 } // namespace ofd
1237 } // namespace foxit
1238
1239 #endif // FS_OFD_DOC_H_
foxit::ofd::OFDDoc::CreateVersion
void CreateVersion()
创建版本，并切换到该版本。只能创建一个版本。
foxit::ofd::OFDDoc::GetCustomTags
CustomTags GetCustomTags()
获取自定义标签。
foxit::ofd::OFDDoc::ImportAnnots
void ImportAnnots(const String &file_path)
导入注释。
foxit::ofd::OFDDoc::GetPage
OFDPage GetPage(int index)
获取OFD页面。
foxit::ofd::OFDDoc::SetCurrentVersion
void SetCurrentVersion(int index)
设置当前版本。
foxit::ofd::OFDDoc::AddCustomData
void AddCustomData(const String &key, const String &value)
添加OFD自定义数据。
foxit::ofd::OFDDoc::InsertCustomData
void InsertCustomData(const String &key, const String &value, int index)
插入OFD自定义数据。
IFX_FileWrite
文件写入接口。
Definition: fx_stream.h:470
foxit::ofd::OFDDoc::operator=
OFDDoc & operator=(const OFDDoc &other)
赋值操作符。
foxit::ofd::Bookmarks
Definition: fs_ofdbookmark.h:176
foxit::ofd::OFDDoc::CustomEncrypt
bool CustomEncrypt(const String &security_type, const String &crypto_type, int key_length, const String &user_password, const String &owner_password)
对文档进行自定义加密。必须先调用 OFDSecurity::RegisterHandler 方法注册自定义加密处理器。
foxit::Object
CFX_Object Object
对象类型。
Definition: fs_basictypes.h:220
foxit::ofd::PageNumberParameter::text_color
foxit::RGB text_color
页码文本颜色。
Definition: fs_ofddoc.h:229
foxit::ofd::OFDDoc::AddTemplatePage
OFDTemplatePage AddTemplatePage()
添加新的模板页面。
foxit::ofd::PageNumberParameter::operator=
PageNumberParameter & operator=(const PageNumberParameter &other)
赋值操作符。
Definition: fs_ofddoc.h:155
foxit::ofd::OFDDoc::e_OFDEncryptTypeRC4
加密类型：RC4。
Definition: fs_ofddoc.h:296
foxit::ofd::OFDDoc::operator !=
bool operator !=(const OFDDoc &other) const
不相等操作符。
foxit::ofd::OFDDoc::GetAttachmentFile
foxit::common::file::ReaderCallback * GetAttachmentFile(int index)
获取OFD附件文件指针。
foxit::ofd::PageNumberParameter::is_folio
bool is_folio
是否为对开页面，true代表是对开页面，false代表不是。
Definition: fs_ofddoc.h:254
foxit::ofd::OFDDoc::GetVersionCount
int GetVersionCount()
获取版本数量。
foxit::ofd::PageNumberParameter::e_PageNumberLocationTypeRightBottom
位置右下。
Definition: fs_ofddoc.h:58
foxit::ofd::OFDDoc::BeginTagTreeNode
void BeginTagTreeNode(const String &key_path)
开始添加票据标引节点。
foxit::ofd::OFDDoc::GetPermissions
OFDPermission GetPermissions()
获取权限对象。
foxit::ofd::OFDDoc::RemoveOutline
bool RemoveOutline()
删除所有大纲节点。
foxit::ofd::TagTreeNode
Definition: fs_ofdtagtreenode.h:21
foxit::ofd::PageNumberParameter::is_first_page_cover
bool is_first_page_cover
首页是否为封面，true代表首页，false代表非首页。
Definition: fs_ofddoc.h:244
foxit::ofd::OFDDoc::GetKeywordCount
int GetKeywordCount()
获取OFD Metadata项数量。
foxit::ofd::Attachment
Definition: fs_ofdattachment.h:122
foxit::ofd::OFDDoc::GetCustomDataCount
int GetCustomDataCount()
获取OFD自定义数据数量。
foxit::ofd::PageNumberParameter::PageNumberParameter
PageNumberParameter(const PageNumberParameter &other)
用另一个页码参数对象的构造函数。
Definition: fs_ofddoc.h:134
foxit::RGB
uint32 RGB
RGB 颜色类型，24 位，((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:211
foxit::ofd::OFDDoc::ExportOfficeDoc
bool ExportOfficeDoc(const String &file_path)
导出公文语义xml文件。
foxit::ofd::OFDDoc::CreateAttachments
Attachments CreateAttachments()
创建OFD附件集合。
foxit::ofd::OFDDoc::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::ofd::OFDDoc::CreateOutline
Outline CreateOutline()
创建大纲。
foxit::ofd::PageNumberParameter::e_PageNumberMarginTypeLarge
边距大。
Definition: fs_ofddoc.h:72
foxit::ofd::OFDDoc::GetCustomDataValue
WString GetCustomDataValue(int index)
获取OFD自定义值。
foxit::ofd::OFDDoc::InsertTemplatePage
OFDTemplatePage InsertTemplatePage(int index)
插入模板页面。
IFX_FileRead
文件读取接口。
Definition: fx_stream.h:587
foxit::ofd::OFDDoc::AddResourceFromFile
foxit::uint32 AddResourceFromFile(const String &file_path, const String &format)
从文件添加资源到OFD文档。
foxit::ofd::OFDDoc::GetPageCount
int GetPageCount()
获取OFD文档页面数量。
foxit::ofd::PageNumberParameter::e_PageNumberLocationTypeRightTop
位置右上。
Definition: fs_ofddoc.h:52
foxit::ofd::OFDDoc::GetMultiMediaFormatByID
WString GetMultiMediaFormatByID(foxit::uint32 res_id)
获取多媒体格式。
CFX_WideString
宽字符串类
Definition: fx_string.h:1457
foxit::ofd::OFDDoc::GetMetadata
WString GetMetadata(const WString &key)
获取OFD Metadata项。
foxit::ofd::PageNumberParameter::e_PageNumberLocationTypeBottomMiddle
位置下中。
Definition: fs_ofddoc.h:56
foxit::ofd::OFDDoc::GetTemplatePageByID
OFDTemplatePage GetTemplatePageByID(int id)
获取OFD模板页面。
foxit::ofd::OFDDoc::GetAttachments
Attachments GetAttachments()
获取OFD附件集合。
foxit::ofd::OFDDoc::GetAttachment
Attachment GetAttachment(int index)
获取OFD附件对象。
foxit::ofd::OFDDoc::GetResourceTypeByID
ResourceType GetResourceTypeByID(foxit::uint32 res_id)
获取资源类型通过资源ID。
foxit::ofd::PageNumberParameter::PageNumberMarginType
PageNumberMarginType
OFD添加页码边距枚举类型。
Definition: fs_ofddoc.h:66
foxit::ofd::OFDDoc::~OFDDoc
~OFDDoc()
析构函数。
foxit::ofd::OFDDoc::ReservedPage
void ReservedPage(int index)
指定保存需要保留的OFD页面。保存后，未保留的页面将被删除。
foxit::ofd::OFDDoc::GetAttachmentByName
Attachment GetAttachmentByName(const String &name)
获取OFD附件对象。
foxit::ofd::PageNumberParameter::Set
void Set(PageNumberLocationType location, const WString &font_name, float font_size, foxit::RGB text_color, int start_page, int end_page, bool is_first_page_cover, int first_page_number, bool is_folio, PageNumberMarginType margin, bool skip_blank_page)
设置值。
Definition: fs_ofddoc.h:193
foxit::ofd::OFDDoc::ExportAttachment
void ExportAttachment(int index, const String &file_path)
保存附件到文件中。
foxit::ofd::OFDDoc::e_OFDEncryptTypeNone
加密类型：无。
Definition: fs_ofddoc.h:294
foxit::ofd::OFDDoc::ResourceType
ResourceType
OFD资源类型枚举类型。
Definition: fs_ofddoc.h:310
foxit::ofd::OFDDoc::e_OFDEncryptMethodCert
加密方法：证书加密
Definition: fs_ofddoc.h:284
foxit::ofd::Outline
Definition: fs_ofdoutline.h:20
foxit::ofd::Attachments
Definition: fs_ofdattachment.h:395
foxit::ofd::OFDDoc::RemoveCustomData
void RemoveCustomData(int index)
删除OFD自定义数据。
fs_image.h
图像和位图相关定义和类的头文件。
foxit::ofd::OFDDoc::MovePage
bool MovePage(int index, int dest_index)
移动页面到指定索引。
foxit::ofd::OFDDoc::AddTagTreeNodeMetaData
void AddTagTreeNodeMetaData(const String &key, const String &value)
添加自定义票据标引树节点元数据。
foxit::ofd::OFDDoc::AddAttachment
Attachment AddAttachment(const String &file_name, const String &name=0, const String &usage=0)
添加附件。
foxit::ofd::OFDDoc::AddPageFromTemplatePage
OFDPage AddPageFromTemplatePage(int index, int dest_index=-1)
添加新的页面。
foxit::ofd::OFDDoc::GetAttachmentBuffer
String GetAttachmentBuffer(int index)
获取OFD附件内存缓冲区。
foxit::ofd::OFDDoc::GetTemplatePageCount
int GetTemplatePageCount()
获取OFD文档模板页面数量。
foxit::ofd::OFDDoc::RemoveAllTemplatePages
void RemoveAllTemplatePages()
删除所有模板页面。
foxit::ofd::CustomTags
Definition: fs_ofdcustomtag.h:105
foxit::ofd::PageNumberParameter::e_PageNumberLocationTypeLeftTop
位置左上。
Definition: fs_ofddoc.h:48
foxit::ofd::OFDDoc::e_OFDResourceTypeFont
字体资源类型。
Definition: fs_ofddoc.h:318
foxit::ofd::OFDPermission
Definition: fs_ofdpermission.h:17
foxit::ofd::OFDDoc::GetSignature
ofdseal::Signature GetSignature(int index)
获取签名或签章对象。
foxit::ofd::OFDDoc::GetMultiMediaFileNameByID
WString GetMultiMediaFileNameByID(foxit::uint32 res_id)
获取多媒体文件名。
foxit::ofd::ofdseal::Signature
Definition: fs_ofdsignature.h:209
foxit::ofd::OFDDoc::EndTagTreeNode
void EndTagTreeNode(const String &key_path)
结束添加票据标引节点。
foxit::ofd::OFDDoc::CreateCustomTags
CustomTags CreateCustomTags()
创建自定义标签。
foxit::ofd::OFDDoc::e_OFDResourceTypeDrawParam
绘制参数资源类型。
Definition: fs_ofddoc.h:316
foxit::ofd::OFDDoc::EncryptMethod
EncryptMethod
OFD文档加密方法枚举类型。
Definition: fs_ofddoc.h:278
foxit::ofd::OFDDoc::GetPageByID
OFDPage GetPageByID(foxit::uint32 id)
获取OFD页面。
foxit::ofd::OFDDoc::RemoveKeyword
void RemoveKeyword(int index)
删除指定关键字。
foxit::ofd::OFDDoc::CreatePermissions
OFDPermission CreatePermissions()
创建权限对象。
foxit::ofd::OFDDoc::GetMultiMediaFileByID
foxit::common::file::ReaderCallback * GetMultiMediaFileByID(int res_id)
通过资源ID获取多媒体文件指针。
foxit::ofd::OFDDoc::AddTemplatePageFromPage
OFDTemplatePage AddTemplatePageFromPage(OFDPage page)
添加新的模板页面。
foxit::ofd::OFDDoc::GetMultiMediaTypeByID
WString GetMultiMediaTypeByID(foxit::uint32 res_id)
获取多媒体类型。
foxit::ofd::PageNumberParameter::e_PageNumberMarginTypeSmall
边距小。
Definition: fs_ofddoc.h:68
foxit::ofd::Catalog
Definition: fs_ofdcatalog.h:19
foxit::ofd::OFDDoc::GetBookmarks
Bookmarks GetBookmarks()
获取书签。
foxit::ofd::OFDDoc::SetMetadata
void SetMetadata(const WString &key, const WString &value)
设置OFD Metadata项。
foxit::ofd::OFDDoc::e_OFDResourceTypeMultimedia
多媒体资源类型。
Definition: fs_ofddoc.h:320
foxit::ofd::OFDDoc::AddCatalog
bool AddCatalog(const Catalog &catalog)
添加目录。
foxit::ofd::OFDDoc::SaveXmlFileAttachment
bool SaveXmlFileAttachment(int index, const String &file_path)
保存XML附件到文件中。
foxit::ofd::OFDDoc::RemovePage
void RemovePage(int index)
删除指定的OFD页面。
foxit::ofd::PageNumberParameter::font_size
float font_size
页码文本字体大小。这应该是一个正值，默认为12。
Definition: fs_ofddoc.h:224
foxit::ofd::PageNumberParameter::font_name
WString font_name
页码文本字体名字。
Definition: fs_ofddoc.h:219
foxit::ofd::OFDDoc::InitializeTagTreeNode
void InitializeTagTreeNode(const String &type, const String &name_space, const String &name, const String &file_extension, bool key_unique)
在文档中初始化指定类型的票据标引树根节点。
foxit::ofd::OFDDoc::e_OFDEncryptTypeAES128
加密类型：AES128。
Definition: fs_ofddoc.h:298
foxit::ofd::OFDDoc::RemoveEncryption
bool RemoveEncryption(const String &owner_password)
移除文档加密。
foxit::ofd::PageNumberParameter::PageNumberParameter
PageNumberParameter()
构造函数。
Definition: fs_ofddoc.h:79
foxit::ofd::OFDDoc::EncryptType
EncryptType
OFD文档加密类型枚举类型。
Definition: fs_ofddoc.h:292
foxit::ofd::OFDDoc::RestoreOriginalDocument
bool RestoreOriginalDocument()
恢复到原始文档。
foxit::ofd::PageNumberParameter::first_page_number
int first_page_number
起始页码的数值，默认为1。
Definition: fs_ofddoc.h:249
foxit::ofd::OFDDoc::e_OFDResourceTypeColorSpace
颜色空间资源类型。
Definition: fs_ofddoc.h:314
foxit::uint32
FX_UINT32 uint32
无符号 32 位整数。
Definition: fs_basictypes.h:195
foxit::ofd::PageNumberParameter::e_PageNumberMarginTypeNormal
边距正常。
Definition: fs_ofddoc.h:70
foxit::ofd::OFDDoc::GetTagTreeRoot
TagTreeNode GetTagTreeRoot(const String &type)
获取指定类型的票据标引树根节点。
foxit::ofd::PageNumberParameter::end_page
int end_page
终止页面，有效范围：从1到(count)。count 由函数 OFDPagckage::GetDocumentCount 返回。
Definition: fs_ofddoc.h:239
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:213
fs_common.h
通用定义和类的头文件。
foxit::ofd::OFDDoc::ClearTagTreeNode
void ClearTagTreeNode()
清除票据标引所有节点。
foxit::ofd::OFDDoc::InsertDocument
bool InsertDocument(const OFDDoc &other, int dest_index=-1)
插入新的文档。
foxit::ofd::OFDTemplatePage
Definition: fs_ofdpage.h:415
foxit::ofd::OFDDoc::InitializeCertTagTreeNode
void InitializeCertTagTreeNode(bool key_unique)
在文档中初始化电子证照标引树根节点。
foxit::ofd::OFDDoc
Definition: fs_ofddoc.h:271
foxit::ofd::OFDDoc::ExportAnnots
void ExportAnnots(const String &file_path)
导出注释。
foxit::ofd::OFDDoc::InsertPage
OFDPage InsertPage(int index)
插入新的OFD页面。
foxit::ofd::OFDDoc::GetMultiMediaBufferByID
String GetMultiMediaBufferByID(foxit::uint32 res_id)
获取多媒体内存缓冲区。
foxit::Base
Definition: fs_basictypes.h:465
foxit::ofd::OFDDoc::e_OFDResourceTypeCompositeGraphicUnit
复合图形单元资源类型。
Definition: fs_ofddoc.h:322
foxit::ofd::OFDDoc::GetAttachmentCount
int GetAttachmentCount()
获取OFD附件数量
foxit::ofd::OFDDoc::EmbedFont
void EmbedFont(const String &font_name)
内嵌字体。
foxit::ofd::OFDDoc::AddFontResourceFromName
foxit::uint32 AddFontResourceFromName(const String &font_family, const String &font_name)
添加字体资源到OFD文档。
foxit::common::Image::Type
Type
图像类型的枚举。
Definition: fs_image.h:457
foxit::ofd::PageNumberParameter::margin
PageNumberMarginType margin
页码位置类型。
Definition: fs_ofddoc.h:262
foxit::ofd::OFDDoc::GetTemplatePage
OFDTemplatePage GetTemplatePage(int index)
获取OFD模板页面。
foxit::ofd::OFDDoc::AddPageNumber
void AddPageNumber(const PageNumberParameter &param)
根据页码参数添加页码。
foxit::ofd::OFDDoc::e_OFDEncryptTypeAES256
加密类型：AES256。
Definition: fs_ofddoc.h:300
foxit::ofd::OFDDoc::e_OFDEncryptMethodPwd
加密方法：密码加密
Definition: fs_ofddoc.h:282
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::ofd::PageNumberParameter
Definition: fs_ofddoc.h:39
foxit::ofd::PageNumberParameter::skip_blank_page
bool skip_blank_page
是否跳过空白页。true代表跳过空白页，false代表不跳过空白页。
Definition: fs_ofddoc.h:267
CFX_ByteString
字节字符串类
Definition: fx_string.h:317
foxit::ofd::OFDDoc::RefreshObjectsPermission
bool RefreshObjectsPermission(bool authenticated)
刷新文档所有对象权限。
foxit::ofd::OFDDoc::GetXmlFileAttachmentCount
int GetXmlFileAttachmentCount()
获取OFD XML附件数量
foxit::ofd::OFDPage
Definition: fs_ofdpage.h:27
foxit::ofd::PageNumberParameter::start_page
int start_page
起始页面，有效范围：从1到(count)。count 由函数 OFDPagckage::GetDocumentCount 返回。
Definition: fs_ofddoc.h:234
foxit::ofd::OFDDoc::GetSignatureCount
int GetSignatureCount()
获取签名和签章数量。
foxit::ofd::OFDDoc::GetOutline
Outline GetOutline()
获取大纲。
foxit::ofd::PageNumberParameter::e_PageNumberLocationTypeTopMiddle
位置上中。
Definition: fs_ofddoc.h:50
foxit::ofd::OFDDoc::AddPage
OFDPage AddPage()
添加新的页面。
NULL
#define NULL
空指针值。
Definition: fx_system.h:792
foxit::ofd::OFDDoc::GetCustomDataName
WString GetCustomDataName(int index)
获取OFD自定义数据。
foxit::ofd::OFDDoc::AddImageResourceFromFile
foxit::uint32 AddImageResourceFromFile(const String &file_path)
从图片文件添加资源到OFD文档。
foxit::ofd::OFDDoc::RemoveTemplatePage
void RemoveTemplatePage(int index)
删除模板页面。
foxit::ofd::OFDDoc::InsertKeyword
void InsertKeyword(const WString &keyword, int index=-1)
插入关键字到OFD Metadata项。
foxit::ofd::OFDDoc::e_OFDEncryptMethodNone
加密方法：无。
Definition: fs_ofddoc.h:280
foxit::ofd::PageNumberParameter::PageNumberParameter
PageNumberParameter(PageNumberLocationType location, const WString &font_name, float font_size, foxit::RGB text_color, int start_page, int end_page, bool is_first_page_cover, int first_page_number, bool is_folio, PageNumberMarginType margin, bool skip_blank_page)
带参数的构造函数。
Definition: fs_ofddoc.h:115
foxit::ofd::OFDDoc::AddImageResourceFromBuffer
foxit::uint32 AddImageResourceFromBuffer(const String &buffer, foxit::common::Image::Type format)
从图片文件添加资源到OFD文档。
foxit::ofd::OFDDoc::e_OFDEncryptTypeSM4
加密类型：SM4。
Definition: fs_ofddoc.h:302
foxit::ofd::OFDDoc::e_OFDResourceTypeUnknown
未知类型。
Definition: fs_ofddoc.h:312
foxit::fld::FLDDoc
Definition: fs_flddoc.h:25
foxit::ofd::PageNumberParameter::location
PageNumberLocationType location
页码位置类型。
Definition: fs_ofddoc.h:214
foxit::ofd::OFDDoc::ExportMultiMediaByID
void ExportMultiMediaByID(foxit::uint32 res_id, const String &file_path)
保存多媒体文件。
foxit::ofd::OFDDoc::CreateBookmarks
Bookmarks CreateBookmarks()
创建书签。
foxit::ofd::OFDDoc::operator==
bool operator==(const OFDDoc &other) const
相等操作符。
foxit::ofd::PageNumberParameter::PageNumberLocationType
PageNumberLocationType
OFD添加页码位置枚举类型。
Definition: fs_ofddoc.h:46
foxit::ofd::OFDDoc::OFDDoc
OFDDoc(const foxit::fld::FLDDoc &doc)
构造函数，从现有foxit::fld::FLDDoc对象。
foxit::ofd::PageNumberParameter::e_PageNumberLocationTypeLeftBottom
位置左下。
Definition: fs_ofddoc.h:54
foxit::ofd::OFDDoc::GetTemplatePageByName
OFDTemplatePage GetTemplatePageByName(const String &name)
获取OFD模板页面。