Foxit PDF SDK
FSDK.FormXObject Class Reference
Inheritance diagram for FSDK.FormXObject:
FSDK.GraphicsObject

Public Member Functions

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

Static Public Member Functions

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

Additional Inherited Members

- Static Public Attributes inherited from FSDK.GraphicsObject
static e_BlendColor
 Creates a color with the hue and saturation of the source color, and the luminosity of the backdrop color. More...
 
static e_BlendColorBurn
 Darkens backdrop color to reflect the source color. More...
 
static e_BlendColorDodge
 Brightens backdrop color to reflect source colors. More...
 
static e_BlendDarken
 Select darker one of backdrop and source colors. More...
 
static e_BlendDifference
 Subtracts the darker of the two constituent colors from lighter colors. More...
 
static e_BlendExclusion
 Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color. More...
 
static e_BlendHardlight
 Multiply or screens colors, depending on source color value. More...
 
static e_BlendHue
 Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color. More...
 
static e_BlendLighten
 Select lighter one of backdrop and source colors. More...
 
static e_BlendLuminosity
 Creates a color with the luminosity of the source color, and the hue and saturation of the backdrop color. More...
 
static e_BlendMultiply
 Multiply backdrop by source color values. More...
 
static e_BlendNormal
 Enumeration for render blend mode. More...
 
static e_BlendOverlay
 Multiply or screens colors, depending on backdrop color value. More...
 
static e_BlendSaturation
 Creates a color with the saturation of the source color, and the hue and luminosity of the backdrop color. More...
 
static e_BlendScreen
 Multiply complements of backdrop by source color values, and then complement the result. More...
 
static e_BlendSoftlight
 Darkens or lightens colors, depending on source color value. More...
 
static e_TypeAll
 Enumeration for PDF graphics object type. More...
 
static e_TypeFormXObject
 Form XObject graphics object.
 
static e_TypeImage
 Image graphics object.
 
static e_TypePath
 Path graphics object.
 
static e_TypeShading
 Shading graphics object.
 
static e_TypeText
 Text graphics object.
 

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 FSDK.FormXObject is derived from class FSDK.GraphicsObject. It offers functions to get/set form XObject's data.
To create a new form XObject graphics object, please use function FSDK.PathObject.Create and then import page content to the new form XObject, or insert new graphics object to form XObject through FSDK.GraphicsObjects object returned by function FSDK.FormXObject.GetGraphicsObjects.

See also
FSDK.GraphicsObject

Member Function Documentation

◆ Create()

static FSDK.FormXObject.Create ( document  )
static

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. If the newly created form XObject will not inserted to any page or other objects, please remember to call function FSDK.GraphicsObject.Release to release it when no use.

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 there is any error, this function will return null.

◆ GetGraphicsObjects()

FSDK.FormXObject.GetGraphicsObjects ( )

Get graphics objects that associated with current form XObject.

Returns
A FSDK.GraphicsObjects object.

◆ GetStream()

FSDK.FormXObject.GetStream ( )

Get stream.

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

◆ ImportPageContent()

FSDK.FormXObject.ImportPageContent ( source_page  ,
is_annots_included   
)

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 FSDK.GraphicsObjects.GenerateContent should be called. Please refer to function FSDK.GraphicsObjects.GenerateContent for more details.