public final class XpsPath extends XpsContentElement
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.
Modifier and Type | Method and Description |
---|---|
XpsPath |
deepClone()
Clones this path.
|
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.
|
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 |
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 |
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).
|
getClip, getOpacity, getOpacityMask, getRenderTransform, setClip, setOpacity, setOpacityMask, setRenderTransform
getHyperlinkTarget, setHyperlinkTarget
get, iterator, size
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach, spliterator
public XpsBrush getFill()
Returns the brush used to paint the geometry specified by the Data property of the path.
public void setFill(XpsBrush value)
Sets the brush used to paint the geometry specified by the Data property of the path.
value
- The brush used to paint the geometry specifiedpublic XpsPathGeometry getData()
Returns the geometry of the path.
public void setData(XpsPathGeometry value)
Sets the geometry of the path.
value
- The geometry of the path.public XpsBrush getStroke()
Returns the brush used to draw the stroke.
public void setStroke(XpsBrush value)
Sets the brush used to draw the stroke.
value
- The brush used to draw the stroke.public float[] getStrokeDashArray()
Returns the array specifying the length of dashes and gaps of the outline stroke.
public void setStrokeDashArray(float[] value)
Sets the array specifying the length of dashes and gaps of the outline stroke.
value
- The array specifying the length of dashes and gaps of the outline stroke.public XpsDashCap getStrokeDashCap()
Returns the value specifying how the ends of each dash are drawn.
public void setStrokeDashCap(XpsDashCap value)
Sets the value specifying how the ends of each dash are drawn.
value
- The value specifying how the ends of each dash are drawn.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.
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.
value
- The start point for repeating the dash array pattern.public XpsLineCap getStrokeStartLineCap()
Returns the value defining the shape of the beginning of the first dash in a stroke.
public void setStrokeStartLineCap(XpsLineCap value)
Sets the value defining the shape of the beginning of the first dash in a stroke.
value
- The value defining the shape of the beginning of the first dash in a stroke.public XpsLineCap getStrokeEndLineCap()
Returns the value defining the shape of the end of the last dash in a stroke.
public void setStrokeEndLineCap(XpsLineCap value)
Sets the value defining the shape of the end of the last dash in a stroke.
value
- The value defining the shape of the end of the last dash in a stroke.public XpsLineJoin getStrokeLineJoin()
Returns the value defining the shape of the beginning of the first dash in a stroke.
public void setStrokeLineJoin(XpsLineJoin value)
Sets the value defining the shape of the beginning of the first dash in a stroke.
value
- The value defining the shape of the beginning of the first dash in a stroke.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
.
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
.
value
- The ratio between the maximum miter length and half of the stroke thickness.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.
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.
value
- The thickness of a stroke.public XpsPath deepClone()
Clones this path.
Copyright © 2020 Aspose. All Rights Reserved.