Foxit PDF SDK
foxit.pdf.graphics.FormXObject Class Reference
Inheritance diagram for foxit.pdf.graphics.FormXObject:
foxit.pdf.graphics.GraphicsObject

Public Member Functions

GraphicsObjects GetGraphicsObjects ()
 Get graphics objects that associated with current form XObject. More...
 
PDFStream GetStream ()
 Get stream. More...
 
bool ImportPageContent (PDFPage source_page, bool is_annots_included)
 Import page content from a specified PDF page to current form XObject. More...
 
- Public Member Functions inherited from foxit.pdf.graphics.GraphicsObject
bool AddClipPath (Path path, FillMode fill_mode)
 Add a path for clipping. More...
 
bool AddClipTextObject (TextObject textobject)
 Add text object for clipping. More...
 
bool ClearClips ()
 Clear all clips. More...
 
GraphicsObject Clone ()
 Clone a new graphics object. More...
 
bool Equal (GraphicsObject other)
 Check if input object is equal to current object. More...
 
GraphicsObject.BlendMode GetBlendMode ()
 Get the blend mode for transparent imaging model. More...
 
Path GetClipPath (int index)
 Get a path clip by index. More...
 
int GetClipPathCount ()
 Get the count of path clip. More...
 
FillMode GetClipPathFillMode (int index)
 Get the fill mode of a path clip by index. More...
 
RectF GetClipRect ()
 Get clip rectangle. More...
 
TextObject GetClipTextObject (int index)
 Get the text object of a text clip by index. More...
 
int GetClipTextObjectCount ()
 Get the count of text clip. More...
 
ColorState GetColorState ()
 Get color state. More...
 
uint GetFillColor ()
 Get the fill color. More...
 
float GetFillOpacity ()
 Get the opacity value for painting operations other than stroking. More...
 
FormXObject GetFormXObject ()
 Get the form XObject graphics object if current graphics object represents a form XObject object. More...
 
GraphState GetGraphState ()
 Get graph state. More...
 
ImageObject GetImageObject ()
 Get the image graphics object if current graphics object represents an image object. More...
 
LayerNodeArray GetLayers (LayerTree layer_tree)
 Get all the layers which are associated with current graphics object. More...
 
MarkedContent GetMarkedContent ()
 Get marked content object. More...
 
Matrix2D GetMatrix ()
 Get matrix. More...
 
PathObject GetPathObject ()
 Get the path graphics object if current graphics object represents a path object. More...
 
RectF GetRect ()
 Get the rectangle of current graphics object. More...
 
ShadingObject GetShadingObject ()
 Get the shading graphics object if current graphics object represents a shading object. More...
 
uint GetStrokeColor ()
 Get the stroke color. More...
 
float GetStrokeOpacity ()
 Get opacity value for stroke painting operations for paths and glyph outlines. More...
 
TextObject GetTextObject ()
 Get the text graphics object if current graphics object represents a text object. More...
 
GraphicsObject.Type GetType ()
 Get the type of current graphics object. More...
 
bool HasTransparency ()
 Check whether current graphics object has transparency or not. More...
 
void Release ()
 Release a cloned or newly created PDF graphics object which has not been inserted into any PDF page or other object. More...
 
bool RemoveClipPath (int index)
 Remove a path clip by index. More...
 
bool RemoveClipTextObject (int index)
 Remove a text clip by index for clipping. More...
 
void Rotate (int angle)
 Rotate current graphics object from current state with specified angle degree in clockwise. More...
 
void SetBlendMode (GraphicsObject.BlendMode blend_mode)
 Set the blend mode for transparent imaging model. More...
 
void SetClipRect (RectF clip_rect)
 Set clip rectangle. More...
 
void SetColorState (ColorState color_state)
 Set color state. More...
 
void SetFillColor (uint color)
 Set the fill color. More...
 
void SetFillOpacity (float opacity)
 Set the opacity value for painting operations other than stroking. More...
 
void SetGraphState (GraphState graph_state)
 Set graph state. More...
 
void SetMatrix (Matrix2D matrix)
 Set matrix. More...
 
void SetStrokeColor (uint color)
 Set the stroke color. More...
 
void SetStrokeOpacity (float opacity)
 Set opacity value for stroke painting operations for paths and glyph outlines. More...
 
bool Transform (Matrix2D matrix, bool need_transform_clippath)
 Transform current graphics object. More...
 

Static Public Member Functions

static FormXObject Create (PDFDoc document)
 Create a new form XObject graphics object. More...
 

Additional Inherited Members

- Public Types inherited from 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
}
 Enumeration for render blend mode. More...
 
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
}
 Enumeration for PDF graphics object type. More...
 

Detailed Description

A form XObject is not only a graphics object, but also a container. A form XObject consists of a set of graphics objects or sub form XObjects. Form XObject is a kind of PDF graphics object, so class foxit.pdf.graphics.FormXObject is derived from class GraphicsObject . It offers functions to get/set form XObject's data.
To create a new form XObject graphics object, please use function PathObject.Create and then import page content to the new form XObject, or insert new graphics object to form XObject through foxit.pdf.GraphicsObjects object returned by function FormXObject.GetGraphicsObjects .

See also
GraphicsObject

Member Function Documentation

◆ Create()

static FormXObject foxit.pdf.graphics.FormXObject.Create ( PDFDoc  document)
inlinestatic

Create a new form XObject graphics object.

The newly created form XObject graphics object does not have any data yet. Then, setting functions can be called to set data to the new form XObject graphics object.

Parameters
[in]documentA valid PDF document object. The new form XObject graphics object should be inserted to one page of this PDF document then.
Returns
A new form XObject.
If the newly created form XObject will not inserted to any page or other objects, please remember to call function GraphicsObject.Release to release it when no use.

◆ GetGraphicsObjects()

GraphicsObjects foxit.pdf.graphics.FormXObject.GetGraphicsObjects ( )
inline

Get graphics objects that associated with current form XObject.

Returns
A foxit.pdf.GraphicsObjects object.

◆ GetStream()

PDFStream foxit.pdf.graphics.FormXObject.GetStream ( )
inline

Get stream.

Returns
A foxit.pdf.objects.PDFStream that represents the stream data of current form XObject. If there is any error, this function will return null.

◆ ImportPageContent()

bool foxit.pdf.graphics.FormXObject.ImportPageContent ( PDFPage  source_page,
bool  is_annots_included 
)
inline

Import page content from a specified PDF page to current form XObject.

If this function succeeds, the boundary box of current form XObject will be the same as page's size.

Parameters
[in]source_pageA valid PDF page object that represents the source PDF page whose content will be imported to current form XObject.
[in]is_annots_includedtrue means annotations should be included with the content of parameter source_page. false means annotations should be ignored from the content of parameter source_page.
Returns
true means success, while false means failure.
Note
When this function succeeds, function GraphicsObjects.GenerateContent should be called. Please refer to function GraphicsObjects.GenerateContent for more details.