Foxit PDF SDK

Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
foxit.pdf.graphics.ImageObject类 参考
类 foxit.pdf.graphics.ImageObject 继承关系图:

## Public 成员函数
Bitmap | CloneBitmap (GraphicsObjects graphics_objects)
Bitmap | CloneBitmap (PDFPage page, GraphicsObjects graphics_objects)
| 从当前图像图形对象克隆位图。 更多...
ColorSpaceType | GetColorSpace ()
| 获取颜色空间。 更多...
PDFObject | GetMask ()
| 获取表示当前图像图形对象蒙版的PDF对象。 更多...
PDFStream | GetStream ()
| 获取图像流。 更多...
bool | IsImageMask ()
| 检查当前图像对象是否被视为蒙版。 更多...
void | SetBitmap (Bitmap bitmap, Bitmap mask)
| 将位图设置到当前图像图形对象。 更多...
void | SetImage (Image image, int frame_index)
| 将图像的一帧设置到当前图像图形对象。 更多...
Public 成员函数 继承自 foxit.pdf.graphics.GraphicsObject
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)
| 变换当前图形对象。 更多...

## 静态 Public 成员函数
static ImageObject | Create (PDFDoc document)
| 创建新的图像图形对象。 更多...
static ImageObject | CreateFromType3TextObject (PDFPage page, TextObject text_obj)
| 从type3文本对象创建图像图形对象。 更多...

## 额外继承的成员函数
Public 类型 继承自 foxit.pdf.graphics.GraphicsObject
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图形对象类型的枚举。 更多...

## 详细描述

图像图形对象是一种PDF图形对象，因此类ImageObject 派生自 类GraphicsObject 。它提供获取/设置图像图形对象数据的函数。
要创建新的图像图形对象，请使用函数ImageObject.Create ，然后 使用设置函数为新的图像图形对象设置信息。

参见
  GraphicsObject

## 成员函数说明

## ◆ CloneBitmap() [1/2]

Bitmap foxit.pdf.graphics.ImageObject.CloneBitmap | ( | GraphicsObjects | graphics_objects | ) |
| inline

弃用:
  此函数已弃用。请使用带两个参数的函数ImageObject.CloneBitmap 。

目前，只有当位图格式是以下格式之一时，才能从图像图形对象克隆位图：
foxit.common.Bitmap.DIBFormat.e_DIB8bppMask 、foxit.common.Bitmap.DIBFormat.e_DIB8bpp 、 foxit.common.Bitmap.DIBFormat.e_DIBRgb 、foxit.common.Bitmap.DIBFormat.e_DIBRgb32 、 foxit.common.Bitmap.DIBFormat.e_DIBArgb 、foxit.common.Bitmap.DIBFormat.e_DIBCmyk 。
如果返回位图对象的函数common.Bitmap.IsEmpty 的返回值为true， 表示位图的DIB格式不受支持。

参数

  [in] | graphics_objects | 有效的foxit.pdf.GraphicsObjects 对象。请确保当前图像图形对象 正好属于此foxit.pdf.GraphicsObjects 对象(可能是PDF页面)。

返回
  新克隆的位图对象。如果返回位图对象的函数common.Bitmap.IsEmpty 的返回值为true， 表示位图的DIB格式不受支持。

## ◆ CloneBitmap() [2/2]

Bitmap foxit.pdf.graphics.ImageObject.CloneBitmap | ( | PDFPage | page,
|  | GraphicsObjects | graphics_objects
| ) |  |
| inline

从当前图像图形对象克隆位图。

目前，只有当位图格式是以下格式之一时，才能从图像图形对象克隆位图：
foxit.common.Bitmap.DIBFormat.e_DIB8bppMask 、foxit.common.Bitmap.DIBFormat.e_DIB8bpp 、 foxit.common.Bitmap.DIBFormat.e_DIBRgb 、foxit.common.Bitmap.DIBFormat.e_DIBRgb32 、 foxit.common.Bitmap.DIBFormat.e_DIBArgb 、foxit.common.Bitmap.DIBFormat.e_DIBCmyk 。
如果返回位图对象的函数common.Bitmap.IsEmpty 的返回值为true， 表示位图的DIB格式不受支持。

参数

  [in] | page | 有效的PDF页面对象。请确保当前图像图形对象正好属于此页面。
  [in] | graphics_objects | 有效的foxit.pdf.GraphicsObjects 对象。请确保当前图像图形对象 正好属于此foxit.pdf.GraphicsObjects 对象(可能是PDF页面)。

返回
  新克隆的位图对象。如果返回位图对象的函数common.Bitmap.IsEmpty 的返回值为true， 表示位图的DIB格式不受支持。

## ◆ Create()

static ImageObject foxit.pdf.graphics.ImageObject.Create | ( | PDFDoc | document | ) |
| inline static

创建新的图像图形对象。

新创建的图像图形对象还没有任何数据。然后，可以调用设置函数 为新的图像图形对象设置数据。 如果新创建的图像图形对象不会插入到任何页面或其他对象中， 请记住在不使用时调用函数GraphicsObject.Release 来释放它。

参数

  [in] | document | 有效的PDF文档对象。然后新的图像图形对象应该插入到 此PDF文档的一个页面中。

返回
  新的图像对象。如果有任何错误，此函数将返回null。

## ◆ CreateFromType3TextObject()

static ImageObject foxit.pdf.graphics.ImageObject.CreateFromType3TextObject | ( | PDFPage | page,
|  | TextObject | text_obj
| ) |  |
| inline static

从type3文本对象创建图像图形对象。

如果新创建的图像图形对象不会插入到任何页面或其他对象中， 请记住在不使用时调用函数GraphicsObject.Release 来释放它。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | text_obj | 有效的文本对象。此文本对象应该是type3文本对象。

返回
  新的图像对象。如果有任何错误，此函数将返回null。

## ◆ GetColorSpace()

ColorSpaceType foxit.pdf.graphics.ImageObject.GetColorSpace | ( |  | ) |
| inline

获取颜色空间。

返回
  颜色空间。请参考从foxit.common.ColorSpaceType.e_ColorSpaceDeviceGray 开始的值， 这将是这些值中的一个。

## ◆ GetMask()

PDFObject foxit.pdf.graphics.ImageObject.GetMask | ( |  | ) |
| inline

获取表示当前图像图形对象蒙版的PDF对象。

蒙版可以是PDF字典或PDF数组：

- PDF字典表示要应用到此图像的图像蒙版。

- PDF数组表示要作为颜色键蒙版应用到图像的颜色范围。

更多详细信息请参阅<PDF Reference 1.7>中的第4.8.4节"图像字典"。

返回
  表示蒙版的PDF对象。 如果ImageObject.IsImageMask 返回true，此函数将返回null。

## ◆ GetStream()

PDFStream foxit.pdf.graphics.ImageObject.GetStream | ( |  | ) |
| inline

获取图像流。

返回
  表示图像流的foxit.pdf.objects.PDFStream 。 如果有任何错误，此函数将返回null。

## ◆ IsImageMask()

bool foxit.pdf.graphics.ImageObject.IsImageMask | ( |  | ) |
| inline

检查当前图像对象是否被视为蒙版。

返回
  true 表示当前对象被视为蒙版，false 表示不是。

## ◆ SetBitmap()

void foxit.pdf.graphics.ImageObject.SetBitmap | ( | Bitmap | bitmap,
|  | Bitmap | mask
| ) |  |
| inline

将位图设置到当前图像图形对象。

参数

  [in] | bitmap | 要设置到当前图像的有效位图对象。
  [in] | mask | 蒙版位图。默认值：通过默认构造函数创建的位图对象，未设置任何值， 表示不使用蒙版。 如果此参数有效，其格式应为foxit.common.Bitmap.DIBFormat.e_DIB8bppMask 。 仅当参数bitmap没有alpha通道时，此参数才有用。

返回
  无

注解
  当此函数成功时，应调用函数GraphicsObjects.GenerateContent 。 更多详细信息请参阅函数GraphicsObjects.GenerateContent 。

## ◆ SetImage()

void foxit.pdf.graphics.ImageObject.SetImage | ( | Image | image,
|  | int | frame_index
| ) |  |
| inline

将图像的一帧设置到当前图像图形对象。

输入图像可能包含多帧，只能将图像的一帧设置到当前图像图形对象。

参数

  [in] | image | 有效的图像对象。此图像应至少包含一帧，图像类型 不应为foxit.common.Image.Type.e_Unknown 。
  [in] | frame_index | 帧索引，用于决定参数image的哪一帧要被设置。 有效范围：从0到(count-1)。count由函数 common.Image.GetFrameCount 返回。

返回
  无

注解
  当此函数成功时，应调用函数GraphicsObjects.GenerateContent 。 更多详细信息请参阅函数GraphicsObjects.GenerateContent 。