Skip to content

GetTextLeading.md

Latest commit

 

History

History
52 lines (41 loc) · 1.24 KB

GetTextLeading.md

File metadata and controls

52 lines (41 loc) · 1.24 KB
Raw

GetTextLeading

Description

Procedure GetTextLeading returns the custom leading value(in points) of the referenced text object.

FUNCTION GetTextLeading(theText : HANDLE): REAL;
def vs.GetTextLeading(theText):
    return REAL

Parameters

Name Type Description
theText HANDLE Handle to text object.

Remarks

If a custom value was not set, this returns -1.0.

Examples

txtLeading_pt := GetTextLeading (H);
txtSpace := GetTextSpace (H);
txtSize := GetTextSize (H, 1);
{
writeln (' ### Issue Text ### txtLeading_pt = ',txtLeading_pt ,'    txtSpace = ',txtSpace,'    txtSize = ',txtSize );

		txtLeading_pt := GetTextLeading (gRevTextH);
		txtSpace := GetTextSpace (gRevTextH);
		txtSize := GetTextSize (gRevTextH, 1);
{
writeln (' *** Revision text *** txtLeading_pt = ',txtLeading_pt ,'    txtSpace = ',txtSpace,'    txtSize = ',txtSize );
import vs

# Procedure GetTextLeading returns the custom leading value(in points) of the
# referenced text object.
theText = 'Example text'

value = vs.GetTextLeading(theText)
vs.Message('GetTextLeading returned: ' + str(value))

Version

Availability: from VectorWorks8.0

Category