Stroke class
Stroke class
Defines a stroke for a shape. To learn more, visit the Working with Shapes documentation article.
Use the Shape.stroke property to access stroke properties of a shape. You do not create instances of the Stroke class directly.
Properties
| Name | Description |
|---|---|
| back_color | Gets or sets the background color of the stroke. |
| color | Defines the color of a stroke. |
| color2 | Defines a second color for a stroke. |
| dash_style | Specifies the dot and dash pattern for a stroke. |
| end_arrow_length | Defines the arrowhead length for the end of a stroke. |
| end_arrow_type | Defines the arrowhead for the end of a stroke. |
| end_arrow_width | Defines the arrowhead width for the end of a stroke. |
| end_cap | Defines the cap style for the end of a stroke. |
| fill | Gets fill formatting for the Stroke. |
| fore_color | Gets or sets the foreground color of the stroke. |
| image_bytes | Defines the image for a stroke image or pattern fill. |
| join_style | Defines the join style of a polyline. |
| line_style | Defines the line style of the stroke. |
| on | Defines whether the path will be stroked. |
| opacity | Defines the amount of transparency of a stroke. Valid range is from 0 to 1. |
| start_arrow_length | Defines the arrowhead length for the start of a stroke. |
| start_arrow_type | Defines the arrowhead for the start of a stroke. |
| start_arrow_width | Defines the arrowhead width for the start of a stroke. |
| transparency | Gets or sets a value between 0.0 (opaque) and 1.0 (clear) representing the degree of transparency of the stroke. |
| visible | Gets or sets a flag indicating whether the stroke is visible. |
| weight | Defines the brush thickness that strokes the path of a shape in points. |
Examples
Shows how change stroke properties.
doc = aw.Document()
builder = aw.DocumentBuilder(doc)
shape = builder.insert_shape(aw.drawing.ShapeType.RECTANGLE, aw.drawing.RelativeHorizontalPosition.LEFT_MARGIN, 100,
aw.drawing.RelativeVerticalPosition.TOP_MARGIN, 100, 200, 200, aw.drawing.WrapType.NONE)
# Basic shapes, such as the rectangle, have two visible parts.
# 1 - The fill, which applies to the area within the outline of the shape:
shape.fill.fore_color = drawing.Color.white
# 2 - The stroke, which marks the outline of the shape:
# Modify various properties of this shape's stroke.
stroke = shape.stroke
stroke.on = True
stroke.weight = 5
stroke.color = drawing.Color.red
stroke.dash_style = aw.drawing.DashStyle.SHORT_DASH_DOT_DOT
stroke.join_style = aw.drawing.JoinStyle.MITER
stroke.end_cap = aw.drawing.EndCap.SQUARE
stroke.line_style = aw.drawing.ShapeLineStyle.TRIPLE
stroke.fill.two_color_gradient(drawing.Color.red, drawing.Color.blue, awd.GradientStyle.VERTICAL, awd.GradientVariant.VARIANT1)
doc.save(ARTIFACTS_DIR + "Shape.stroke.docx")
See Also
- module aspose.words.drawing
- property Shape.stroke