Skip to content

SetDashStyleName.md

Latest commit

 

History

History
52 lines (41 loc) · 1.2 KB

SetDashStyleName.md

File metadata and controls

52 lines (41 loc) · 1.2 KB
Raw

SetDashStyleName

Description

Sets the dash style name of the specified dash style index.

FUNCTION SetDashStyleName(
				DashStyleIndex : INTEGER;
				DashStyleName  : STRING): BOOLEAN;
def vs.SetDashStyleName(DashStyleIndex, DashStyleName):
    return BOOLEAN

Parameters

Name Type Description
DashStyleIndex INTEGER The index of the dash style to be named.
DashStyleName STRING The new name of the dash style specified by the index.

Remarks

_c_, (2014.04.08): This sets the name in the dash style list, not in the name list. It seems to be a left over from the time before introduction of dash styles as named resources.

Examples

resultOK := SetDashStyleName(1, 'Example');
import vs

# Sets the dash style name of the specified dash style index.
DashStyleIndex = 1
DashStyleName = 'Example'

ok = vs.SetDashStyleName(DashStyleIndex, DashStyleName)
if ok:
    vs.Message('SetDashStyleName succeeded')
else:
    vs.Message('SetDashStyleName failed')

See Also

VS Functions: GetDashStyleName

Version

Availability: from Vectorworks 2011

Category