Foxit PDF SDK
foxit::ofd::OFDTemplatePage类 参考
类 foxit::ofd::OFDTemplatePage 继承关系图:
foxit::ofd::OFDPage foxit::Base

Public 成员函数

 ~OFDTemplatePage ()
 析构函数。
 
bool SetName (const WString &name)
 设置模板页的名称。 更多...
 
- Public 成员函数 继承自 foxit::ofd::OFDPage
 OFDPage (const OFDPage &other)
 构造函数,通过另一个OFD页面对象。 更多...
 
 ~OFDPage ()
 析构函数。
 
Annot AddAnnot (Annot::AnnotType type)
 新建一个标注对象并添加到页中。 更多...
 
OFDLayer AddLayer ()
 新建一个层,并追加至页中。 更多...
 
foxit::ofd::graphics::OFDBlockObject AddPageBlock ()
 新建一个页面块。这个接口将创建一个Layer插入到页面,在Layer中添加页面块。 更多...
 
bool FillRect (const RectF &rect, foxit::RGB color)
 将指定区域填充为指定颜色。 更多...
 
Actions GetActions () const
 获取页面动作数组。 更多...
 
Annot GetAnnot (int index)
 按索引获取标注对象。 更多...
 
Annot GetAnnotByID (foxit::uint32 id)
 按ID获取标注对象。 更多...
 
int GetAnnotCount ()
 获取页中标注数量。 更多...
 
Matrix GetDisplayMatrix (int left, int top, int width, int height, common::Rotation rotate) const
 计算渲染矩阵。 更多...
 
int GetID () const
 获取页ID。 更多...
 
int GetIndex () const
 获取页索引。 更多...
 
OFDLayer GetLayer (int index) const
 获取指定索引的层句柄。 更多...
 
int GetLayerCount () const
 获取页中层数。 更多...
 
RectF GetPageBox (PageBoxType box_type) const
 获取页面区域。 更多...
 
common::Rotation GetRotation () const
 获取页面旋转角度。 更多...
 
int GetTemplatePageCount () const
 获取页中模板页数。 更多...
 
WString GetTextByLineIndex (int index)
 获取指定行的文本内容。 更多...
 
int GetTextLineCount ()
 获取页面文本行数。 更多...
 
OFDLayer InsertLayer (int index)
 新建一个层,并插入页中指定位置。 更多...
 
foxit::ofd::graphics::OFDBlockObject InsertPageBlock (int index)
 新建一个页面块。这个接口将创建一个Layer插入到页面,在Layer中添加页面块。 更多...
 
bool IsDoubleLayer ()
 判断页面是否为双层页面。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool IsTemplatePage () const
 判断当前页面是否为模板页。 更多...
 
bool MaskCharacterWithBlack (const RectF &rect, int shape)
 通过涂黑进行页面信息屏蔽。 更多...
 
bool MaskCharacterWithBlur (const RectF &rect, int shape, int horz_blur, int vert_blur)
 通过模糊进行页面信息屏蔽。 更多...
 
bool MaskCharacterWithMosaic (const RectF &rect, int shape, int vector_length)
 通过马赛克进行页面信息屏蔽。 更多...
 
bool operator != (const OFDPage &other) const
 不相等操作符。 更多...
 
OFDPageoperator= (const OFDPage &other)
 赋值操作符。 更多...
 
bool operator== (const OFDPage &other) const
 相等操作符。 更多...
 
bool PreMaskCharacterByRect (const RectF &rect, foxit::ARGB color)
 页面信息预遮盖,可恢复。 更多...
 
bool RemoveAnnot (int index)
 删除指定索引的标注对象。 更多...
 
bool RemoveLayer (int index)
 删除指定索引的层。 更多...
 
bool RemovePageBlock (int index)
 删除指定索引页面块。 更多...
 
bool ReplaceCharacterBySearch (TextSearchCharInfo char_info, foxit::uint8 character='X')
 根据搜索结果,完成字符替换。 更多...
 
bool ReplaceCharacterInRect (const RectF &rect, bool recover=true, foxit::uint8 character='X')
 根据矩形区域,完成字符替换。 更多...
 
bool SetPageBox (PageBoxType box_type, const RectF &rect)
 设置页面区域。 更多...
 
bool SetRotation (common::Rotation rotate)
 设置页面旋转。 更多...
 
bool SetTemplatePage (OFDPage template_page, foxit::ofd::OFDLayer::LayerType order=foxit::ofd::OFDLayer::e_LayerTypeBody)
 设置模板页属性。 更多...
 
bool SetTemplatePageByID (int template_id, foxit::ofd::OFDLayer::LayerType order=foxit::ofd::OFDLayer::e_LayerTypeBody)
 根据指定ID,设置页面的模板属性和呈现顺序。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

额外继承的成员函数

- Public 类型 继承自 foxit::ofd::OFDPage
enum  PageBoxType {
  e_BleedBox = 0, e_PhysicalBox = 1, e_ApplicationBox = 2, e_ContentBox = 3,
  e_CropBox = 4
}
 OFD页面区域类型枚举。 更多...
 

详细描述

此类表示和OFD模板页的方法。

成员函数说明

◆ SetName()

bool foxit::ofd::OFDTemplatePage::SetName ( const WString name)

设置模板页的名称。

参数
[in]name模板页名称。
返回
true代表设置成功, false代表设置失败。