%%PageItemTitle%%

VectorDraw Web Library

previous page next page
JsPropertiesExtractor Send comments on this topic.
blockref Method
See Also  Example
vdWebLibrary Namespace > ScriptCommands Class : blockref Method
blockname
The name of an existing block in the GetBlocks .Required.
parameters
A 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.Scale in X,Y of the block 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 block reference to the document.

Syntax

JScript 
public function blockref( 
   blockname : String,
   parameters : Object[],
   callback : ScriptEntityDelegate
);

Parameters

blockname
The name of an existing block in the GetBlocks .Required.
parameters
A 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.Scale in X,Y of the block 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.blockref('VectorDraw'); // begins a user action to add an existing block reference to block with name 'VectorDraw'
C#Copy Code
// Inserts a new block in the document  using active , color , linetype,layer etc properties,  reference to block with name 'VectorDraw',  insertion point 2,2  Scale 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.blockref('VectorDraw', [[2,2,0],2.0, vdgeo.DegreesToRadians(45)]);  
setTimeout(vdrawObj.redraw);//post a redraw command
C#Copy Code
// Inserts a new block in the document  using active , color , linetype,layer etc properties,  reference to block with name 'VectorDraw',  insertion point 2,2  Scale 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.blockref('VectorDraw', [[2,2,0],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 block reference. If parameters are not null then a new block reference 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.

NOTE: When adding a new text, the characters must be already defined in the vds file that you already select to vdcanvas. By default all characters from 0 to 255 for all textstyles and additionally all characters that are used by vdText,vdMtext objects in the drawing, are exported . If you want to use additional characters or to ensure that some characters always exist in the webControl, you must add them during the vddocument.ExportScript call from VectorDraw FrameWork It can be done by using the 3rd parameter in the parameters argument of the ExportScript

For Example string ensureCharacters = "Coffee - Filter and Ground"; object [] paramenters = new object[]{null,6,ensureCharacters .ToCharArray()}; document.ExportScript("myfilename.vds",null,paramenters );

See Also

previous page start next page