Packages

com.aspose.xps

java.lang.Object
- com.aspose.xps.XpsElement
- - com.aspose.xps.XpsPath

All Implemented Interfaces:

Iterable<XpsElement>
```
public final class XpsPath
extends XpsElement
```
Class incapsulating Path element features. This element is the sole means of adding vector graphics and images to a fixed page. It defines a single vector graphic to be rendered on a page.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`XpsPath`	`deepClone()` Clones this path.
`XpsPathGeometry`	`getClip()` Returns the path geometry instance limitting the rendered region of the element.
`XpsPathGeometry`	`getData()` Returns the geometry of the path.
`XpsBrush`	`getFill()` Returns the brush used to paint the geometry specified by the Data property of the path.
`XpsHyperlinkTarget`	`getHyperlinkTarget()` Returns The hyperlink target object.
`float`	`getOpacity()` Returns the value defining the uniform transparency of the path element.
`XpsBrush`	`getOpacityMask()` Returns the brush specifying a mask of alpha values that is applied to the path in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.
`XpsMatrix`	`getRenderTransform()` Returns the affine transformation matrix establishing a new coordinate frame for all attributes of the path and for all child elements of the path, such as the geometry defined by the Path.Data property element.
`XpsBrush`	`getStroke()` Returns the brush used to draw the stroke.
`float[]`	`getStrokeDashArray()` Returns the array specifying the length of dashes and gaps of the outline stroke.
`XpsDashCap`	`getStrokeDashCap()` Returns the value specifying how the ends of each dash are drawn.
`float`	`getStrokeDashOffset()` Returns the start point for repeating the dash array pattern.
`XpsLineCap`	`getStrokeEndLineCap()` Returns the value defining the shape of the end of the last dash in a stroke.
`XpsLineJoin`	`getStrokeLineJoin()` Returns the value defining the shape of the beginning of the first dash in a stroke.
`float`	`getStrokeMiterLimit()` Returns the ratio between the maximum miter length and half of the stroke thickness.
`XpsLineCap`	`getStrokeStartLineCap()` Returns the value defining the shape of the beginning of the first dash in a stroke.
`float`	`getStrokeThickness()` Returns the thickness of a stroke, in units of the effective coordinate space (includes the path's render transform).
`void`	`setClip(XpsPathGeometry value)` Sets the path geometry instance limitting the rendered region of the element.
`void`	`setData(XpsPathGeometry value)` Sets the geometry of the path.
`void`	`setFill(XpsBrush value)` Sets the brush used to paint the geometry specified by the Data property of the path.
`void`	`setHyperlinkTarget(XpsHyperlinkTarget value)` Sets the hyperlink target object.
`void`	`setOpacity(float value)` Sets the value defining the uniform transparency of the path element.
`void`	`setOpacityMask(XpsBrush value)` Sets the brush specifying a mask of alpha values that is applied to the path in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.
`void`	`setRenderTransform(XpsMatrix value)` Sets the affine transformation matrix establishing a new coordinate frame for all attributes of the path and for all child elements of the path, such as the geometry defined by the Path.Data property element.
`void`	`setStroke(XpsBrush value)` Sets the brush used to draw the stroke.
`void`	`setStrokeDashArray(float[] value)` Sets the array specifying the length of dashes and gaps of the outline stroke.
`void`	`setStrokeDashCap(XpsDashCap value)` Sets the value specifying how the ends of each dash are drawn.
`void`	`setStrokeDashOffset(float value)` Sets the start point for repeating the dash array pattern.
`void`	`setStrokeEndLineCap(XpsLineCap value)` Sets the value defining the shape of the end of the last dash in a stroke.
`void`	`setStrokeLineJoin(XpsLineJoin value)` Sets the value defining the shape of the beginning of the first dash in a stroke.
`void`	`setStrokeMiterLimit(float value)` Sets the ratio between the maximum miter length and half of the stroke thickness.
`void`	`setStrokeStartLineCap(XpsLineCap value)` Sets the value defining the shape of the beginning of the first dash in a stroke.
`void`	`setStrokeThickness(float value)` Sets the thickness of a stroke, in units of the effective coordinate space (includes the path's render transform).

Methods inherited from class com.aspose.xps.XpsElement
get, iterator, size

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - getFill
```
public XpsBrush getFill()
```
    Returns the brush used to paint the geometry specified by the Data property of the path.
    
    Returns:
    
    The brush used to paint the geometry specified
  - setFill
```
public void setFill(XpsBrush value)
```
    Sets the brush used to paint the geometry specified by the Data property of the path.
    
    Parameters:
    
    value - The brush used to paint the geometry specified
  - getData
```
public XpsPathGeometry getData()
```
    Returns the geometry of the path.
    
    Returns:
    
    The geometry of the path.
  - setData
```
public void setData(XpsPathGeometry value)
```
    Sets the geometry of the path.
    
    Parameters:
    
    value - The geometry of the path.
  - getRenderTransform
```
public XpsMatrix getRenderTransform()
```
    Returns the affine transformation matrix establishing a new coordinate frame for all attributes of the path and for all child elements of the path, such as the geometry defined by the Path.Data property element.
    
    Returns:
    
    The affine transformation matrix.
  - setRenderTransform
```
public void setRenderTransform(XpsMatrix value)
```
    Sets the affine transformation matrix establishing a new coordinate frame for all attributes of the path and for all child elements of the path, such as the geometry defined by the Path.Data property element.
    
    Parameters:
    
    value - The affine transformation matrix.
  - getClip
```
public XpsPathGeometry getClip()
```
    Returns the path geometry instance limitting the rendered region of the element.
    
    Returns:
    
    The path geometry instance limitting the rendered region of the element.
  - setClip
```
public void setClip(XpsPathGeometry value)
```
    Sets the path geometry instance limitting the rendered region of the element.
    
    Parameters:
    
    value - The path geometry instance limitting the rendered region of the element.
  - getOpacity
```
public float getOpacity()
```
    Returns the value defining the uniform transparency of the path element.
    
    Returns:
    
    The value defining the uniform transparency of the path element.
  - setOpacity
```
public void setOpacity(float value)
```
    Sets the value defining the uniform transparency of the path element.
    
    Parameters:
    
    value - The value defining the uniform transparency of the path element.
  - getOpacityMask
```
public XpsBrush getOpacityMask()
```
    Returns the brush specifying a mask of alpha values that is applied to the path in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.
    
    Returns:
    
    The brush specifying a mask.
  - setOpacityMask
```
public void setOpacityMask(XpsBrush value)
```
    Sets the brush specifying a mask of alpha values that is applied to the path in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.
    
    Parameters:
    
    value - The brush specifying a mask.
  - getStroke
```
public XpsBrush getStroke()
```
    Returns the brush used to draw the stroke.
    
    Returns:
    
    The brush used to draw the stroke.
  - setStroke
```
public void setStroke(XpsBrush value)
```
    Sets the brush used to draw the stroke.
    
    Parameters:
    
    value - The brush used to draw the stroke.
  - getStrokeDashArray
```
public float[] getStrokeDashArray()
```
    Returns the array specifying the length of dashes and gaps of the outline stroke.
    
    Returns:
    
    The array specifying the length of dashes and gaps of the outline stroke.
  - setStrokeDashArray
```
public void setStrokeDashArray(float[] value)
```
    Sets the array specifying the length of dashes and gaps of the outline stroke.
    
    Parameters:
    
    value - The array specifying the length of dashes and gaps of the outline stroke.
  - getStrokeDashCap
```
public XpsDashCap getStrokeDashCap()
```
    Returns the value specifying how the ends of each dash are drawn.
    
    Returns:
    
    The value specifying how the ends of each dash are drawn.
  - setStrokeDashCap
```
public void setStrokeDashCap(XpsDashCap value)
```
    Sets the value specifying how the ends of each dash are drawn.
    
    Parameters:
    
    value - The value specifying how the ends of each dash are drawn.
  - getStrokeDashOffset
```
public float getStrokeDashOffset()
```
    Returns the start point for repeating the dash array pattern. If this value is omitted, the dash array aligns with the origin of the stroke.
    
    Returns:
    
    The start point for repeating the dash array pattern.
  - setStrokeDashOffset
```
public void setStrokeDashOffset(float value)
```
    Sets the start point for repeating the dash array pattern. If this value is omitted, the dash array aligns with the origin of the stroke.
    
    Parameters:
    
    value - The start point for repeating the dash array pattern.
  - getStrokeStartLineCap
```
public XpsLineCap getStrokeStartLineCap()
```
    Returns the value defining the shape of the beginning of the first dash in a stroke.
    
    Returns:
    
    The value defining the shape of the beginning of the first dash in a stroke.
  - setStrokeStartLineCap
```
public void setStrokeStartLineCap(XpsLineCap value)
```
    Sets the value defining the shape of the beginning of the first dash in a stroke.
    
    Parameters:
    
    value - The value defining the shape of the beginning of the first dash in a stroke.
  - getStrokeEndLineCap
```
public XpsLineCap getStrokeEndLineCap()
```
    Returns the value defining the shape of the end of the last dash in a stroke.
    
    Returns:
    
    The value defining the shape of the end of the last dash in a stroke.
  - setStrokeEndLineCap
```
public void setStrokeEndLineCap(XpsLineCap value)
```
    Sets the value defining the shape of the end of the last dash in a stroke.
    
    Parameters:
    
    value - The value defining the shape of the end of the last dash in a stroke.
  - getStrokeLineJoin
```
public XpsLineJoin getStrokeLineJoin()
```
    Returns the value defining the shape of the beginning of the first dash in a stroke.
    
    Returns:
    
    The value defining the shape of the beginning of the first dash in a stroke.
  - setStrokeLineJoin
```
public void setStrokeLineJoin(XpsLineJoin value)
```
    Sets the value defining the shape of the beginning of the first dash in a stroke.
    
    Parameters:
    
    value - The value defining the shape of the beginning of the first dash in a stroke.
  - getStrokeMiterLimit
```
public float getStrokeMiterLimit()
```
    Returns the ratio between the maximum miter length and half of the stroke thickness. This value is significant only if the StrokeLineJoin attribute specifies Miter.
    
    Returns:
    
    The ratio between the maximum miter length and half of the stroke thickness.
  - setStrokeMiterLimit
```
public void setStrokeMiterLimit(float value)
```
    Sets the ratio between the maximum miter length and half of the stroke thickness. This value is significant only if the StrokeLineJoin attribute specifies Miter.
    
    Parameters:
    
    value - The ratio between the maximum miter length and half of the stroke thickness.
  - getStrokeThickness
```
public float getStrokeThickness()
```
    Returns the thickness of a stroke, in units of the effective coordinate space (includes the path's render transform). The stroke is drawn on top of the boundary of the geometry specified by the Path element’s Data property. Half of the StrokeThickness extends outside of the geometry specified by the Data property and the other half extends inside of the geometry.
    
    Returns:
    
    The thickness of a stroke.
  - setStrokeThickness
```
public void setStrokeThickness(float value)
```
    Sets the thickness of a stroke, in units of the effective coordinate space (includes the path's render transform). The stroke is drawn on top of the boundary of the geometry specified by the Path element’s Data property. Half of the StrokeThickness extends outside of the geometry specified by the Data property and the other half extends inside of the geometry.
    
    Parameters:
    
    value - The thickness of a stroke.
  - getHyperlinkTarget
```
public XpsHyperlinkTarget getHyperlinkTarget()
```
    Returns The hyperlink target object.
    
    Returns:
    
    The hyperlink target object.
  - setHyperlinkTarget
```
public void setHyperlinkTarget(XpsHyperlinkTarget value)
```
    Sets the hyperlink target object.
    
    Parameters:
    
    value - The hyperlink target object.
  - deepClone
```
public XpsPath deepClone()
```
    Clones this path.
    
    Returns:
    
    Clone this path.

Packages

com.aspose.xps

Classes

Enums

Class XpsPath

Method Summary

Methods inherited from class com.aspose.xps.XpsElement

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

getFill

setFill

getData

setData

getRenderTransform

setRenderTransform

getClip

setClip

getOpacity

setOpacity

getOpacityMask

setOpacityMask

getStroke

setStroke

getStrokeDashArray

setStrokeDashArray

getStrokeDashCap

setStrokeDashCap

getStrokeDashOffset

setStrokeDashOffset

getStrokeStartLineCap

setStrokeStartLineCap

getStrokeEndLineCap

setStrokeEndLineCap

getStrokeLineJoin

setStrokeLineJoin

getStrokeMiterLimit

setStrokeMiterLimit

getStrokeThickness

setStrokeThickness

getHyperlinkTarget

setHyperlinkTarget

deepClone