Foxit PDF SDK

Public Member Functions | Static Public Member Functions | List of all members
FSDK.PathObject Class Reference
Inheritance diagram for FSDK.PathObject:

## Public Member Functions
| GetFillMode ()
| Get fill mode. More...
| GetPathData ()
| Get the path data. More...
| GetStrokeState ()
| Get stroke state. More...
| SetFillMode (fill_mode)
| Set fill mode. More...
| SetPathData (path_data)
| Set the path data. More...
| SetStrokeState (is_stroke)
| Set stroke state. 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 PDF page has transparency or not. More...
| IsScanned ()
| Check whether current PDF page is scanned page 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 ()
| Create a new path graphics object. More...
static | CreateFromTextObject (page, text_obj)
| Create a path graphics object from a text 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

Path graphics object is a kind of PDF graphics object, so class FSDK.PathObject is derived from class FSDK.GraphicsObject. It offers functions to get/set path graphics object's data.
To create a new path graphics object, please use function FSDK.PathObject.Create and then use setting functions to set information to the new path graphics object. Function FSDK.PathObject.CreateFromTextObject can be used to create a path graphics object from a text graphics object.

See also
  FSDK.GraphicsObject

## Member Function Documentation

## ◆ Create()

static FSDK.PathObject.Create | ( |  | ) |
| static

Create a new path graphics object.

The newly created path graphics object does not have any data yet. Then, setting functions can be called to set data to the new path graphics object. If the newly created path graphics object will not inserted to any page or other objects, please remember to call function FSDK.GraphicsObject.Release to release it when no use.

Returns
  A new path graphics object. If there is any error, this function will return null.

## ◆ CreateFromTextObject()

static FSDK.PathObject.CreateFromTextObject | ( | page | ,
|  | text_obj |
| ) |  |
| static

Create a path graphics object from a text object.

If the newly created path graphics object 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] | page | A valid PDF page object.
  [in] | text_obj | A text graphics object. It should not be null. Please ensure the text graphics object is in the PDF page specified by parameter page.

Returns
  A new path graphics object. If there is any error, this function will return null.

## ◆ GetFillMode()

FSDK.PathObject.GetFillMode | ( |  | ) |

Get fill mode.

Returns
  Fill mode. Please refer to values starting from FSDK.e_FillModeNone and this would be one of these values.

## ◆ GetPathData()

FSDK.PathObject.GetPathData | ( |  | ) |

Get the path data.

Returns
  Path data. If the return value of function FSDK.Path.IsEmpty for the returned path object is true, that means there is any error.

## ◆ GetStrokeState()

FSDK.PathObject.GetStrokeState | ( |  | ) |

Get stroke state.

Returns
  true means current path graphics object is stroked, and false means current path graphics object is not stroked.

## ◆ SetFillMode()

FSDK.PathObject.SetFillMode | ( | fill_mode |  | ) |

Set fill mode.

Parameters

  [in] | fill_mode | Fill mode. Please refer to values starting from FSDK.e_FillModeNone and this should be one of these values.

Returns
  None.

Note
  When this function succeeds, function FSDK.GraphicsObjects.GenerateContent should be called. Please refer to function FSDK.GraphicsObjects.GenerateContent for more details.

## ◆ SetPathData()

FSDK.PathObject.SetPathData | ( | path_data |  | ) |

Set the path data.

Parameters

  [in] | path_data | A valid path object which represents the path data to be set.

Returns
  None.

Note
  When this function succeeds, function FSDK.GraphicsObjects.GenerateContent should be called. Please refer to function FSDK.GraphicsObjects.GenerateContent for more details.

## ◆ SetStrokeState()

FSDK.PathObject.SetStrokeState | ( | is_stroke |  | ) |

Set stroke state.

Parameters

  [in] | is_stroke | true means current path graphics object is to be stroked. false means current path graphics object is not to be stroked.

Returns
  None.

Note
  When this function succeeds, function FSDK.GraphicsObjects.GenerateContent should be called. Please refer to function FSDK.GraphicsObjects.GenerateContent for more details.