Foxit PDF SDK

Public 成员函数 | 所有成员列表
foxit::ofd::CustomTags类 参考
类 foxit::ofd::CustomTags 继承关系图:

## Public 成员函数
| CustomTags (const CustomTags &other)
| 构造函数，通过另一个自定义标签集合对象。 更多...
| ~CustomTags ()
| 析构函数。
CustomTag | AddCustomTag (int index)
| 添加一个自定义标签对象。 更多...
void | BeginOfficeNode (const String &tag_name)
| 开始新的公文语义节点标标签。 更多...
OfficeNode | CreateOfficeNode ()
| 创建一个空的公文语义节点。 更多...
bool | CreateOfficeNodeByXmlBuffer (const void *data, size_t data_len)
| 通过XML缓冲区创建公文语义节点。 更多...
bool | CreateOfficeNodeByXmlFile (const String &file_path)
| 通过XML文件创建公文语义节点。 更多...
bool | CreateOfficeNodeByXmlFile (const WString &file_path)
| 通过XML文件创建公文语义节点。 更多...
bool | CreateOfficeNodeByXmlFile (foxit::common::file::ReaderCallback *file_reader)
| 通过XML文件创建公文语义节点。 更多...
void | EndOfficeNode (const String &tag_name)
| 结束当前公文语义节点标标签。 更多...
CustomTag | GetCustomTag (int index)
| 获取指定索引的自定义标签对象。 更多...
int | GetCustomTagCount ()
| 获取自定义标签的数量。 更多...
OfficeNode | GetOfficeNode ()
| 获取公文语义节点。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator != (const CustomTags &other) const
| 不相等操作符。 更多...
CustomTags & | operator= (const CustomTags &other)
| 赋值操作符。 更多...
bool | operator== (const CustomTags &other) const
| 相等操作符。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示和OFD自定义标签集合相关的操作。

## 构造及析构函数说明

## ◆ CustomTags()

foxit::ofd::CustomTags::CustomTags | ( | const CustomTags & | other | ) |

构造函数，通过另一个自定义标签集合对象。

参数

  [in] | other | 另一个自定义标签集合对象。

## 成员函数说明

## ◆ AddCustomTag()

CustomTag foxit::ofd::CustomTags::AddCustomTag | ( | int | index | ) |

添加一个自定义标签对象。

参数

  [in] | index | 指定的自定义标签索引，有效范围：从0到(count)。 count由函数 foxit::ofd::CustomTags::GetCustomTagCount 返回。

返回
  自定义标签对象。

## ◆ BeginOfficeNode()

void foxit::ofd::CustomTags::BeginOfficeNode | ( | const String & | tag_name | ) |

开始新的公文语义节点标标签。

参数

  [in] | tag_name | 指定的标签名称。

返回
  无。

## ◆ CreateOfficeNode()

OfficeNode foxit::ofd::CustomTags::CreateOfficeNode | ( |  | ) |

创建一个空的公文语义节点。

返回
  公文语义节点对象。

## ◆ CreateOfficeNodeByXmlBuffer()

bool foxit::ofd::CustomTags::CreateOfficeNodeByXmlBuffer | ( | const void * | data,
|  | size_t | data_len
| ) |  |

通过XML缓冲区创建公文语义节点。

参数

  [in] | data | 指向XML数据缓冲区的指针。
  [in] | data_len | XML数据缓冲区的长度，以字节为单位。

返回
  true 表示成功，false 表示失败。

## ◆ CreateOfficeNodeByXmlFile() [1/3]

bool foxit::ofd::CustomTags::CreateOfficeNodeByXmlFile | ( | const String & | file_path | ) |

通过XML文件创建公文语义节点。

参数

  [in] | file_path | 指定的XML文件路径。

返回
  true 表示成功，false 表示失败。

## ◆ CreateOfficeNodeByXmlFile() [2/3]

bool foxit::ofd::CustomTags::CreateOfficeNodeByXmlFile | ( | const WString & | file_path | ) |

通过XML文件创建公文语义节点。

参数

  [in] | file_path | 指定的XML文件路径。

返回
  true 表示成功，false 表示失败。

## ◆ CreateOfficeNodeByXmlFile() [3/3]

bool foxit::ofd::CustomTags::CreateOfficeNodeByXmlFile | ( | foxit::common::file::ReaderCallback * | file_reader | ) |

通过XML文件创建公文语义节点。

参数

  [in] | file_reader | 用户实现的 foxit::common::file::ReaderCallback 对象，用于读取XML文件。

返回
  true 表示成功，false 表示失败。

## ◆ EndOfficeNode()

void foxit::ofd::CustomTags::EndOfficeNode | ( | const String & | tag_name | ) |

结束当前公文语义节点标标签。

参数

  [in] | tag_name | 指定的标签名称。

返回
  无。

## ◆ GetCustomTag()

CustomTag foxit::ofd::CustomTags::GetCustomTag | ( | int | index | ) |

获取指定索引的自定义标签对象。

参数

  [in] | index | 指定的自定义标签索引，有效范围：从0到(count - 1)。 count由函数 foxit::ofd::CustomTags::GetCustomTagCount 返回。

返回
  指定索引的自定义标签对象。

## ◆ GetCustomTagCount()

int foxit::ofd::CustomTags::GetCustomTagCount | ( |  | ) |

获取自定义标签的数量。

返回
  自定义标签的数量。

## ◆ GetOfficeNode()

OfficeNode foxit::ofd::CustomTags::GetOfficeNode | ( |  | ) |

获取公文语义节点。

返回
  公文语义节点对象。

## ◆ IsEmpty()

bool foxit::ofd::CustomTags::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

当前对象为空时，表示当前对象是无用的。

返回
  true 表示当前对象为空，false 表示不为空。

## ◆ operator !=()

bool foxit::ofd::CustomTags::operator != | ( | const CustomTags & | other | ) | const

不相等操作符。

参数

  [in] | other | 另一个自定义标签集合对象。此函数将检查当前对象是否不等于这个对象。

返回
  true 表示不相等，false 表示相等。

## ◆ operator=()

CustomTags& foxit::ofd::CustomTags::operator= | ( | const CustomTags & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个自定义标签集合对象，其值将被赋给当前对象。

返回
  当前对象自身的引用。

## ◆ operator==()

bool foxit::ofd::CustomTags::operator== | ( | const CustomTags & | other | ) | const

相等操作符。

参数

  [in] | other | 另一个自定义标签集合对象。此函数将检查当前对象是否等于这个对象。

返回
  true 表示相等，false 表示不相等。