Skip to content

GetFontID.md

Latest commit

 

History

History
85 lines (71 loc) · 2.38 KB

GetFontID.md

File metadata and controls

85 lines (71 loc) · 2.38 KB
Raw

GetFontID

Description

Function GetFontID converts the string name of an available font to a font ID which can be passed to other VectorScript routines.

FUNCTION GetFontID(fontName : STRING): INTEGER;
def vs.GetFontID(fontName):
    return INTEGER

Parameters

Name Type Description
fontName STRING Name of installed font.

Remarks

returns -1 if the requested font is not available

Examples

VectorScript

PROCEDURE Example;
VAR
str :STRING;
BEGIN
str := StrDialog('Enter the font name:', 'Arial');
AlrtDialog(Concat('The font ID is: ', GetFontID(str)));
END;
RUN(Example);

Python

def Example():
	str = vs.StrDialog('Enter the font name:', 'Arial')
	vs.AlrtDialog(vs.Concat('The font ID is: ', vs.GetFontID(str)))

Example()
BEGIN
	getData := FALSE;
	createErrorMessage2( errorText, kErrMsgTextSize, GetFontID( kErrMsgTextFont ), kErrMsgWidth, gX0, gY0, kBeep );
	HRotate( LNewObj, gX0, gY0, -GetSymRot( gPluginH ) );
END

BeginText;
	str
EndText;
tmpH := LNewObj;
SetTextFont( tmpH, 0, GetTextLength( tmpH ) , GetFontID( tmpStruct.NotesFormat.font ) );
SetTextSize( tmpH, 0, GetTextLength( tmpH ) , tmpStruct.NotesFormat.size );
SetTextStyle( tmpH, 0, GetTextLength( tmpH ) , tmpStruct.NotesFormat.style );
SetRField( gnH, kGeneralNotes, kCPt2x, Num2Str( realPrecision, GetTextWidth( tmpH ) ) );
DelObj( tmpH );

fieldVal := GetRField(parmH, parmN, fieldN);
if version >= 1000 then BEGIN
	SetRField(parmH, parmN, fieldN, GetFontName(GetObjectVariableInt(parmH, 28)));
end else IF (fieldVal <> '') THEN BEGIN
	SetObjectVariableInt(parmH, 28, GetFontID(fieldVal));
	TextFont(GetFontID(fieldVal));
END;
import vs

# Function GetFontID converts the string name of an available font to a font
# ID which can be passed to other VectorScript routines.
fontName = 'Arial'

resultN = vs.GetFontID(fontName)
vs.Message('GetFontID returned: ' + str(resultN))

See also in tutorials: 09. Dimensioning and Text Annotation, 27. Formatted Wall Schedule, 28. Symbol Instance Schedule, 29. Cross-Layer Summary

Version

Availability: from VectorWorks8.0

Category