public class Canvas extends Object
The canvas. The Canvas element groups elements together. Glyphs and Path elements can be grouped in a canvas in order to be identified as a unit(as a hyperlink destination) or to apply a composed property value to each child and ancestor element.
| Constructor and Description |
|---|
Canvas()
Initializes a new instance of the
Canvas class. |
| Modifier and Type | Method and Description |
|---|---|
String |
getAutomationPropertiesHelpText()
Gets or sets the automation properties help text.
|
String |
getAutomationPropertiesName()
Gets or sets the automation properties name.
|
Geometry |
getCanvasClip()
Gets or sets the canvas clip.
|
Brush |
getCanvasOpacityMask()
Gets or sets the canvas opacity mask.
|
Transform |
getCanvasRenderTransform()
Gets or sets the canvas render transform.
|
Resources |
getCanvasResources()
Gets or sets the canvas resources.
|
String |
getClip()
Gets or sets the clip.
|
String |
getFixedPageNavigateUri()
Gets or sets the fixed page navigate uri.
|
Object[] |
getItems()
Gets or sets the items.
|
String |
getLanguage()
Gets or sets the language.
|
String |
getName()
Gets or sets the name.
|
double |
getOpacity()
Gets or sets the opacity.
|
String |
getOpacityMask()
Gets or sets the opacity mask.
|
String |
getRenderOptionsEdgeMode()
Gets or sets the render options edge mode.
|
boolean |
getRenderOptionsEdgeModeSpecified()
Gets or sets a value indicating whether render options edge mode specified.
|
String |
getRenderTransform()
Gets or sets the render transform.
|
void |
setAutomationPropertiesHelpText(String value)
Gets or sets the automation properties help text.
|
void |
setAutomationPropertiesName(String value)
Gets or sets the automation properties name.
|
void |
setCanvasClip(Geometry value)
Gets or sets the canvas clip.
|
void |
setCanvasOpacityMask(Brush value)
Gets or sets the canvas opacity mask.
|
void |
setCanvasRenderTransform(Transform value)
Gets or sets the canvas render transform.
|
void |
setCanvasResources(Resources value)
Gets or sets the canvas resources.
|
void |
setClip(String value)
Gets or sets the clip.
|
void |
setFixedPageNavigateUri(String value)
Gets or sets the fixed page navigate uri.
|
void |
setItems(Object[] value)
Gets or sets the items.
|
void |
setLanguage(String value)
Gets or sets the language.
|
void |
setName(String value)
Gets or sets the name.
|
void |
setOpacity(double value)
Gets or sets the opacity.
|
void |
setOpacityMask(String value)
Gets or sets the opacity mask.
|
void |
setRenderOptionsEdgeMode(String value)
Gets or sets the render options edge mode.
|
void |
setRenderOptionsEdgeModeSpecified(boolean value)
Gets or sets a value indicating whether render options edge mode specified.
|
void |
setRenderTransform(String value)
Gets or sets the render transform.
|
public Canvas()
Initializes a new instance of the Canvas class.
public final Resources getCanvasResources()
Gets or sets the canvas resources. Contains the resource dictionary for the Canvas element.
public final void setCanvasResources(Resources value)
Gets or sets the canvas resources. Contains the resource dictionary for the Canvas element.
public final Transform getCanvasRenderTransform()
Gets or sets the canvas render transform. Establishes a new coordinate frame for the child and descendant elements of the canvas, such as another canvas.Also affects clip and opacity mask.
public final void setCanvasRenderTransform(Transform value)
Gets or sets the canvas render transform. Establishes a new coordinate frame for the child and descendant elements of the canvas, such as another canvas.Also affects clip and opacity mask.
public final Geometry getCanvasClip()
Gets or sets the canvas clip. Limits the rendered region of the element.
public final void setCanvasClip(Geometry value)
Gets or sets the canvas clip. Limits the rendered region of the element.
public final Brush getCanvasOpacityMask()
Gets or sets the canvas opacity mask. Specifies a mask of alpha values that is applied to the canvas in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.
public final void setCanvasOpacityMask(Brush value)
Gets or sets the canvas opacity mask. Specifies a mask of alpha values that is applied to the canvas in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.
public final Object[] getItems()
Gets or sets the items. Grouped together FixedPage descendant elements.
public final void setItems(Object[] value)
Gets or sets the items. Grouped together FixedPage descendant elements.
public final String getRenderTransform()
Gets or sets the render transform. Establishes a new coordinate frame for the child and descendant elements of the canvas, such as another canvas. Also affects clip and opacity mask.
public final void setRenderTransform(String value)
Gets or sets the render transform. Establishes a new coordinate frame for the child and descendant elements of the canvas, such as another canvas. Also affects clip and opacity mask.
public final String getClip()
Gets or sets the clip. Limits the rendered region of the element.
public final void setClip(String value)
Gets or sets the clip. Limits the rendered region of the element.
public final double getOpacity()
Gets or sets the opacity. Defines the uniform transparency of the canvas. Values range from 0 (fully transparent) to 1 (fully opaque), inclusive. Values outside of this range are invalid.
public final void setOpacity(double value)
Gets or sets the opacity. Defines the uniform transparency of the canvas. Values range from 0 (fully transparent) to 1 (fully opaque), inclusive. Values outside of this range are invalid.
public final String getOpacityMask()
Gets or sets the opacity mask. Specifies a mask of alpha values that is applied to the canvas in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.
public final void setOpacityMask(String value)
Gets or sets the opacity mask. Specifies a mask of alpha values that is applied to the canvas in the same fashion as the Opacity attribute, but allowing different alpha values for different areas of the element.
public final String getName()
Gets or sets the name. Contains a string value that identifies the current element as a named, addressable point in the document for the purpose of hyperlinking.
public final void setName(String value)
Gets or sets the name. Contains a string value that identifies the current element as a named, addressable point in the document for the purpose of hyperlinking.
public final String getRenderOptionsEdgeMode()
Gets or sets the render options edge mode. Controls how edges of paths within the canvas are rendered. The only valid value is Aliased. Omitting this attribute causes the edges to be rendered in the consumer's default manner.
public final void setRenderOptionsEdgeMode(String value)
Gets or sets the render options edge mode. Controls how edges of paths within the canvas are rendered. The only valid value is Aliased. Omitting this attribute causes the edges to be rendered in the consumer's default manner.
public final boolean getRenderOptionsEdgeModeSpecified()
Gets or sets a value indicating whether render options edge mode specified.
public final void setRenderOptionsEdgeModeSpecified(boolean value)
Gets or sets a value indicating whether render options edge mode specified.
public final String getFixedPageNavigateUri()
Gets or sets the fixed page navigate uri. Associates a hyperlink URI with the element. May be a relative reference or a URI that addresses a resource that is internal to or external to the package.
public final void setFixedPageNavigateUri(String value)
Gets or sets the fixed page navigate uri. Associates a hyperlink URI with the element. May be a relative reference or a URI that addresses a resource that is internal to or external to the package.
public final String getLanguage()
Gets or sets the language. Specifies the default language used for the current element and for any child or descendant elements. The language is specified according to RFC 3066.
public final void setLanguage(String value)
Gets or sets the language. Specifies the default language used for the current element and for any child or descendant elements. The language is specified according to RFC 3066.
public final String getAutomationPropertiesName()
Gets or sets the automation properties name. A brief description of the Canvas contents for accessibility purposes, particularly if filled with a set of vector graphics and text elements intended to comprise a single vector graphic.
public final void setAutomationPropertiesName(String value)
Gets or sets the automation properties name. A brief description of the Canvas contents for accessibility purposes, particularly if filled with a set of vector graphics and text elements intended to comprise a single vector graphic.
public final String getAutomationPropertiesHelpText()
Gets or sets the automation properties help text. A detailed description of the Canvas contents for accessibility purposes, particularly if filled with a set of graphics and text elements intended to comprise a single vector graphic.
public final void setAutomationPropertiesHelpText(String value)
Gets or sets the automation properties help text. A detailed description of the Canvas contents for accessibility purposes, particularly if filled with a set of graphics and text elements intended to comprise a single vector graphic.
Copyright (c) 2008-2025 Aspose Pty Ltd. All Rights Reserved.