%%PageItemTitle%%

VectorDraw Web Library

previous page next page
JsPropertiesExtractor Send comments on this topic.
text Method
See Also  Example
vdWebLibrary Namespace > ScriptCommands Class : text Method
textstring
A string display value of the text.Required.
parameters
An array of parameters in the following order, used for no user action. 1.Insertion point in world coordinate system, as an array of 3 numbers(X,Y,Z) 2.Rotation angle in radians
callback
A user function of ScriptEntityDelegate type, that will be called when the command finish successfully.It can be ignored.
Add a text to the document.

Syntax

JScript 
public function text( 
   textstring : String,
   parameters : Object[],
   callback : ScriptEntityDelegate
);

Parameters

textstring
A string display value of the text.Required.
parameters
An array of parameters in the following order, used for no user action. 1.Insertion point in world coordinate system, as an array of 3 numbers(X,Y,Z) 2.Rotation angle in radians
callback
A user function of ScriptEntityDelegate type, that will be called when the command finish successfully.It can be ignored.

Example

C#Copy Code
vdrawobj.scriptCommand.textstyle('standard',2.0,'center','center');//select the active tetxtstyle , height , justification for the text object. 
vdrawobj.scriptCommand.text('VectorDraw'); // begins a user action to add a text with string value 'VectorDraw'
C#Copy Code
// draw a text  using active textstyle, color , linetype,layer etc properties, with textstyle standard, height 2.0, justification center, display string 'VectorDraw', insertion point 2,2   and rotation angle 45 degrees 
//after this command is finished the object is not drawn on screen. 
//You can call the vdrawObj.redraw after adding an amount of commands 
vdrawobj.scriptCommand.textstyle('standard',2.0,'center','center');//select the active tetxtstyle , height , justification for the text object. 
vdrawobj.scriptCommand.text('VectorDraw', [[2,2,0], vdgeo.DegreesToRadians(45)]);  
setTimeout(vdrawObj.redraw);//post a redraw command
C#Copy Code
// draw a text using active color , linetype,layer etc properties,  with textstyle standard, height 2.0, justification center, display string 'VectorDraw', insertion point 2,2   and rotation angle 45 degrees 
//after this command is finished the object is not drawn on screen. 
In order to display it call vdrawObj.DrawEntity and <see cref="M:vdWebLibrary.vdrawObj.Refresh"/>  inside the user define callback .See example. 
 
function actionentityadded(vdraw, entity) { 
   vdraw.DrawEntity(entity); 
   setTimeout(vdraw.Refresh);//post a refresh command 
            } 
vdrawobj.scriptCommand.textstyle('standard',2.0,'center','center');//select the active tetxtstyle , height , justification for the text object. 
vdrawobj.scriptCommand.text('VectorDraw', [[2,2,0], vdgeo.DegreesToRadians(45)] , actionentityadded);

Remarks

if passed parameters not exist or it is null then start a new user action and prompts the user to draw a text. If parameters are not null then a new text is added synchronously depend on the passed parameters. The command add the action to undo history and also to script lines getCommands If parameters are not null and after this command is finished the object is not drawn on screen In order to display it call DrawEntity and Refresh inside the user define callback .See example.

See Also

previous page start next page