|
Foxit PDF SDK
|
Public 类型 | |
| enum | BlendMode { BlendMode.e_BlendNormal = 0, BlendMode.e_BlendMultiply = 1, BlendMode.e_BlendScreen = 2, BlendMode.e_BlendOverlay = 3, BlendMode.e_BlendDarken = 4, BlendMode.e_BlendLighten = 5, BlendMode.e_BlendColorDodge = 6, BlendMode.e_BlendColorBurn = 7, BlendMode.e_BlendHardlight = 8, BlendMode.e_BlendSoftlight = 9, BlendMode.e_BlendDifference = 10, BlendMode.e_BlendExclusion = 11, BlendMode.e_BlendHue = 21, BlendMode.e_BlendSaturation = 22, BlendMode.e_BlendColor = 23, BlendMode.e_BlendLuminosity = 24 } |
| 渲染混合模式的枚举。 更多... | |
| enum | Type { Type.e_TypeAll = 0, Type.e_TypeText = 1, Type.e_TypePath = 2, Type.e_TypeImage = 3, Type.e_TypeShading = 4, Type.e_TypeFormXObject = 5, Type.e_TypeInlines = 6, Type.e_TypeEmptyMarkedContent = 7 } |
| PDF图形对象类型的枚举。 更多... | |
Public 成员函数 | |
| bool | AddClipPath (Path path, FillMode fill_mode) |
| 添加用于裁剪的路径。 更多... | |
| bool | AddClipTextObject (TextObject textobject) |
| 添加用于裁剪的文本对象。 更多... | |
| bool | ClearClips () |
| 清除所有裁剪。 更多... | |
| GraphicsObject | Clone () |
| 克隆新的图形对象。 更多... | |
| GraphicsObject | Clone (GraphicsObjects src_graphicsobjects, GraphicsObjects dest_graphicsobjects) |
| 克隆新的图形对象。 更多... | |
| bool | Equal (GraphicsObject other) |
| 检查输入对象是否与当前对象相等。 更多... | |
| GraphicsObject.BlendMode | GetBlendMode () |
| 获取透明成像模型的混合模式。 更多... | |
| Path | GetClipPath (int index) |
| 根据索引获取路径裁剪。 更多... | |
| int | GetClipPathCount () |
| 获取路径裁剪的数量。 更多... | |
| FillMode | GetClipPathFillMode (int index) |
| 根据索引获取路径裁剪的填充模式。 更多... | |
| RectF | GetClipRect () |
| 获取裁剪矩形。 更多... | |
| TextObject | GetClipTextObject (int index) |
| 根据索引获取文本裁剪的文本对象。 更多... | |
| int | GetClipTextObjectCount () |
| 获取文本裁剪的数量。 更多... | |
| ColorState | GetColorState () |
| 获取颜色状态。 更多... | |
| uint | GetFillColor () |
| 获取填充颜色。 更多... | |
| float | GetFillOpacity () |
| 获取除描边外的绘制操作的不透明度值。 更多... | |
| FormXObject | GetFormXObject () |
| 如果当前图形对象表示表单XObject对象,则获取表单XObject图形对象。 更多... | |
| GraphState | GetGraphState () |
| 获取图形状态。 更多... | |
| ImageObject | GetImageObject () |
| 如果当前图形对象表示图像对象,则获取图像图形对象。 更多... | |
| LayerNodeArray | GetLayers (LayerTree layer_tree) |
| 获取与当前图形对象关联的所有图层。 更多... | |
| MarkedContent | GetMarkedContent () |
| 获取标记内容对象。 更多... | |
| Matrix2D | GetMatrix () |
| 获取矩阵。 更多... | |
| PathObject | GetPathObject () |
| 如果当前图形对象表示路径对象,则获取路径图形对象。 更多... | |
| RectF | GetRect () |
| 获取当前图形对象的矩形。 更多... | |
| ShadingObject | GetShadingObject () |
| 如果当前图形对象表示阴影对象,则获取阴影图形对象。 更多... | |
| uint | GetStrokeColor () |
| 获取描边颜色。 更多... | |
| float | GetStrokeOpacity () |
| 获取路径和字形轮廓的描边绘制操作的不透明度值。 更多... | |
| TextObject | GetTextObject () |
| 如果当前图形对象表示文本对象,则获取文本图形对象。 更多... | |
| GraphicsObject.Type | GetType () |
| 获取当前图形对象的类型。 更多... | |
| bool | HasTransparency () |
| 检查当前图形对象是否具有透明度。 更多... | |
| void | Release () |
| 释放尚未插入到任何PDF页面中的克隆或新创建的PDF图形对象或其他对象。 更多... | |
| bool | RemoveClipPath (int index) |
| 根据索引删除路径裁剪。 更多... | |
| bool | RemoveClipTextObject (int index) |
| 根据索引删除用于裁剪的文本裁剪。 更多... | |
| void | Rotate (int angle) |
| 从当前状态以指定的角度顺时针旋转当前图形对象。 更多... | |
| void | SetBlendMode (GraphicsObject.BlendMode blend_mode) |
| 设置透明成像模型的混合模式。 更多... | |
| void | SetClipRect (RectF clip_rect) |
| 设置裁剪矩形。 更多... | |
| void | SetColorState (ColorState color_state) |
| 设置颜色状态。 更多... | |
| void | SetFillColor (uint color) |
| 设置填充颜色。 更多... | |
| void | SetFillOpacity (float opacity) |
| 设置除描边外的绘制操作的不透明度值。 更多... | |
| void | SetGraphState (GraphState graph_state) |
| 设置图形状态。 更多... | |
| void | SetMatrix (Matrix2D matrix) |
| 设置矩阵。 更多... | |
| void | SetStrokeColor (uint color) |
| 设置描边颜色。 更多... | |
| void | SetStrokeOpacity (float opacity) |
| 设置路径和字形轮廓的描边绘制操作的不透明度值。 更多... | |
| bool | Transform (Matrix2D matrix, bool need_transform_clippath) |
| 变换当前图形对象。 更多... | |
PDF页面的内容通常由一系列图形对象组成。每个图形对象包含其状态信息、数据和渲染指令。
类GraphicsObject 是所有类型PDF图形对象的基类。 它提供获取/设置图形对象通用属性的基本函数。对于具体的图形对象类型,请参阅派生类。
要获取或插入/删除图形对象,请参阅类foxit.pdf.GraphicsObjects 。
如果对PDF图形对象进行了任何更改,请记住为foxit.pdf.GraphicsObjects 对象 (当前图形对象所属的对象)调用函数GraphicsObjects.GenerateContent 。 更多详细信息请参阅函数GraphicsObjects.GenerateContent 的注释。
|
strong |
渲染混合模式的枚举。
此枚举的值应单独使用。
|
strong |
添加用于裁剪的路径。
| [in] | path | 要添加到当前图形对象的路径数据。 |
| [in] | fill_mode | 输入路径的填充模式。请参考从 foxit.common.FillMode.e_FillModeNone 开始的值,这应该是这些值中的一个。 |
|
inline |
添加用于裁剪的文本对象。
| [in] | textobject | 要添加用于裁剪的文本对象。 |
|
inline |
清除所有裁剪。
|
inline |
克隆新的图形对象。
新克隆的图形对象默认与当前图形对象关联到同一页面。 新克隆的图形对象只能在包含当前图形对象的PDF文件内使用。 如果克隆的图形对象未插入到任何PDF页面或其他对象中, 请记住在不再使用时调用函数GraphicsObject.Release 来释放它。
|
inline |
克隆新的图形对象。
新克隆的图形对象与dest_graphicsobjects所属的页面相关联。 新克隆的图形对象可以在包含当前图形对象的PDF文件内外使用。 如果克隆的图形对象未插入到任何PDF页面或其他对象中, 请记住在不再使用时调用函数GraphicsObject.Release 来释放它。
| [in] | src_graphicsobjects | 包含当前图形对象的GraphicsObjects 对象。 |
| [in] | dest_graphicsobjects | 将包含克隆图形对象的GraphicsObjects 对象。 这可以属于当前文档中的另一页面或另一文档中的页面。 |
|
inline |
检查输入对象是否与当前对象相等。
| [in] | other | 另一个图形对象。此函数将检查当前对象是否与该对象相等。 |
|
inline |
获取透明成像模型的混合模式。
|
inline |
根据索引获取路径裁剪。
| [in] | index | 路径裁剪索引。有效范围:从0到(count-1)。 count 由函数GraphicsObject.GetClipPath 返回。 |
|
inline |
获取路径裁剪的数量。
|
inline |
根据索引获取路径裁剪的填充模式。
| [in] | index | 路径裁剪索引。有效范围:从0到(count-1)。 count 由函数GraphicsObject.GetClipPath 返回。 |
|
inline |
获取裁剪矩形。
|
inline |
根据索引获取文本裁剪的文本对象。
| [in] | index | 文本裁剪索引。有效范围:从0到(count-1)。 count 由函数GraphicsObject.GetClipTextObjectCount 返回。 |
|
inline |
获取文本裁剪的数量。
|
inline |
获取颜色状态。
文本图形对象、路径图形对象和表单XObject图形对象可以具有颜色状态。
|
inline |
获取填充颜色。
文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。 函数GraphicsObject.GetColorState 可用于获取其他颜色空间(如CMYK颜色空间)中的填充颜色。
|
inline |
获取除描边外的绘制操作的不透明度值。
|
inline |
如果当前图形对象表示表单XObject对象,则获取表单XObject图形对象。
|
inline |
获取图形状态。
表单XObject图形对象、路径图形对象和文本图形对象可以具有此属性。
|
inline |
如果当前图形对象表示图像对象,则获取图像图形对象。
|
inline |
获取与当前图形对象关联的所有图层。
| [in] | layer_tree | 有效的图层树。此图层树中的所有图层节点将按顺序枚举, 以查找与当前图形对象关联的图层。 |
|
inline |
获取标记内容对象。
|
inline |
获取矩阵。
|
inline |
如果当前图形对象表示路径对象,则获取路径图形对象。
|
inline |
获取当前图形对象的矩形。
|
inline |
如果当前图形对象表示阴影对象,则获取阴影图形对象。
|
inline |
获取描边颜色。
文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。
函数GraphicsObject.GetColorState 可用于获取其他颜色空间(如CMYK颜色空间)中的描边颜色。
|
inline |
获取路径和字形轮廓的描边绘制操作的不透明度值。
|
inline |
如果当前图形对象表示文本对象,则获取文本图形对象。
|
inline |
获取当前图形对象的类型。
|
inline |
检查当前图形对象是否具有透明度。
|
inline |
释放尚未插入到任何PDF页面中的克隆或新创建的PDF图形对象或其他对象。
|
inline |
根据索引删除路径裁剪。
| [in] | index | 路径裁剪索引。有效范围:从0到(count-1)。 count 由函数GraphicsObject.GetClipPath 返回。 |
|
inline |
根据索引删除用于裁剪的文本裁剪。
| [in] | index | 文本裁剪索引。有效范围:从0到(count-1)。 count 由函数GraphicsObject.GetClipTextObjectCount 返回。 |
|
inline |
从当前状态以指定的角度顺时针旋转当前图形对象。
| [in] | angle | 角度值,用于从当前状态顺时针旋转当前图形对象。 值范围:从0到360。特别地,如果输入值为0或360(表示不旋转当前图形对象), 当前函数将不执行任何操作。 |
|
inline |
设置透明成像模型的混合模式。
| [in] | blend_mode | 新的混合模式。请参考从foxit.pdf.graphics.GraphicsObject.BlendMode.e_BlendNormal 开始的值, 这应该是这些值中的一个。 |
|
inline |
设置裁剪矩形。
新的裁剪矩形将默认使用填充模式foxit.common.FillMode.e_FillModeWinding 设置。
| [in] | clip_rect | 新的裁剪矩形。 |
|
inline |
设置颜色状态。
文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。 如果尝试为其余不支持的类型设置颜色状态,将抛出异常foxit.common.ErrorCode.e_ErrUnsupported 。
| [in] | color_state | 要设置到当前图形对象的颜色状态对象。 |
|
inline |
设置填充颜色。
文本图形对象、路径图形对象和表单XObject图形对象可以具有颜色状态。 如果尝试为其余不支持的类型设置填充颜色,将抛出foxit.common.ErrorCode.e_ErrUnsupported 。
对于路径图形对象,请确保填充模式不是foxit.common.FillMode.e_FillModeNone ; 否则填充颜色将不会对路径图形对象产生任何影响。请参阅函数 PathObject.GetFillMode 和PathObject.SetFillMode 来 检查和更改路径图形对象的填充模式。
此函数仅设置RGB颜色值。 如果需要设置其他颜色空间(如CMYK颜色空间)的填充颜色, 可以使用函数GraphicsObject.SetColorState 。
| [in] | color | 新的颜色值,格式为0xAARRGGBB。 |
|
inline |
设置除描边外的绘制操作的不透明度值。
| [in] | opacity | 新的不透明度值。有效范围:0.0到1.0。 0.0表示完全透明,1.0表示完全不透明。 |
|
inline |
设置图形状态。
表单XObject图形对象、路径图形对象和文本图形对象(其文本模式为 foxit.pdf.graphics.TextState.Mode.e_ModeStroke 、foxit.pdf.graphics.TextState.Mode.e_ModeStrokeClip 、 foxit.pdf.graphics.TextState.Mode.e_ModeFillStroke 或foxit.pdf.graphics.TextState.Mode.e_ModeFillStrokeClip ) 可以具有此属性。如果尝试为其余不支持的类型设置图形状态,将抛出异常 foxit.common.ErrorCode.e_ErrUnsupported 。
| [in] | graph_state | 新的图形状态。 |
|
inline |
设置矩阵。
| [in] | matrix | 新的矩阵值。 |
|
inline |
设置描边颜色。
文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。 如果当前图形对象是文本图形对象且文本模式为foxit.pdf.graphics.TextState.Mode.e_ModeFill , 描边颜色将不会对文本图形对象产生影响。
如果尝试为其余不支持的类型设置描边颜色,将抛出异常foxit.common.ErrorCode.e_ErrUnsupported 。
函数GraphicsObject.SetColorState 可用于在其他颜色空间(如CMYK颜色空间)中设置描边颜色。
| [in] | color | 新的颜色值,格式为0xAARRGGBB。 |
|
inline |
设置路径和字形轮廓的描边绘制操作的不透明度值。
| [in] | opacity | 新的不透明度值。有效范围:0.0到1.0。 0.0表示完全透明,1.0表示完全不透明。 |
|
inline |
变换当前图形对象。
| [in] | matrix | 变换矩阵。 |
| [in] | need_transform_clippath | true 表示与当前图形对象一起变换裁剪路径。 false 表示仅变换当前图形对象。 |