SetCustomLineDash

Vector graphics

Description

Sets a custom line dash pattern.

Syntax

Delphi

function TPDFlib.SetCustomLineDash(Const DashPattern: WideString; DashPhase: Double): Integer;

ActiveX

Function PDFlib::SetCustomLineDash(DashPattern As String, DashPhase As Double) As Long

DLL

int DLSetCustomLineDash(int InstanceID, wchar_t * DashPattern, double DashPhase);

Parameters

DashPatternA list of numeric values separated with commas. Alternate values are used for dashes and spaces. A period must be used for numbers with decimal fractions. For example, to make a dash-dot-dot pattern the following could be used: "20.5,10,11,10,11,10"
DashPhaseThe distance within the pattern to start the dashed line. For example, if DashPattern is "20,10,40,10" and DashPhase is set to 5, the dashed line will start with a dash of size 15. The next dash will be 40, then 20, then 40, etc. with spaces of 10 between each dash.

Return values

0The dash pattern was not valid The custom dash pattern was set successfully
1