Skip to main content

GetDashType

Gets the dash type of the stroke.

Syntax​

expression.GetDashType();

expression - A variable that represents a ApiStroke class.

Parameters​

This method doesn't have any parameters.

Returns​

DashType | null

Example​

Read the dash pattern of a shape border in a document.

// How do I find out what dash pattern is applied to a shape's border in a document?

// Retrieve and display the line dash style used on a shape border in a document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let fill = Api.CreateSolidFill(Api.CreateRGBColor(255, 200, 100));
let stroke = Api.CreateStroke(36000, Api.CreateSolidFill(Api.CreateRGBColor(0, 0, 255)));
let shape = Api.CreateShape("rect", 100 * 36000, 50 * 36000, fill, stroke);
paragraph.AddDrawing(shape);
paragraph.AddLineBreak();
let retrievedStroke = shape.GetLine();
let dashType = retrievedStroke.GetDashType();
paragraph.AddText("Dash type: " + (dashType ? dashType : "not set"));