Method ExportScript
- Namespace
- VectorDraw.Professional.vdObjects
- Assembly
- VectorDraw.Professional.dll
ExportScript(string, object, object)
Converts and exports the document to the appropriate format in order to be opened by the vdWeb library.
public bool ExportScript(string filename, object lics, object parameters)Parameters
filenamestringThe full filename where the document will be exported to, normally ending in a .vds suffix.
licsobjectNo need to set lics anymore , contact support@vdraw.com for our new method of licensing.An Arrray of strings containing the licvals to be used with the exported file. These licval codes are used to define the location from where the files will be loaded. For more info contact support@vdraw.com
parametersobjectAn object Array that defines various parameters used to specify properties of the exportation. Null can be used and default properties will be used (for the whole parameter or specific elements of the array).
Position 0 of parameters Array is a vdPrimariesList object defining objects from the document that normally would be purged, but the user wants to keep (such as empty layers).
Position 1 is the decimal precision, meaning an integer value defining how many decimal points will be considered for equality comparisons. Also this many digits after the comma will be saved for every decimal value, in the document.
Position 2 is a char Array object defining characters the user wants to use (in a form for example) that are not already present in the document. If this list is not populated, certain characters may be not able to draw properly
Position 3 is a boolean value indicating whether font files should be embedded in the exported file, or simply copied separately to the destination folder.
Position 4 is a string object that contains a path where additional files (e.g font files) needed for the export can be found.
Returns
- bool
True if the command was successfuly completed.
- See Also
ExportScript(string, string[], object[])
Converts and exports the document to the appropriate format in order to be opened by the vdWeb library.
public bool ExportScript(string filename, string[] lics, object[] parameters)Parameters
filenamestringThe full filename where the document will be exported to, normally ending in a .vds suffix.
licsstring[]No need to set lics anymore , contact support@vdraw.com for our new method of licensing.An Arrray of strings containing the licvals to be used with the exported file. These licval codes are used to define the location from where the files will be loaded. For more info contact support@vdraw.com
parametersobject[]An object Array that defines various parameters used to specify properties of the exportation. Null can be used and default properties will be used (for the whole parameter or specific elements of the array).
Position 0 of parameters Array is a vdPrimariesList object defining objects from the document that normally would be purged, but the user wants to keep (such as empty layers).
Position 1 is the decimal precision, meaning an integer value defining how many decimal points will be considered for equality comparisons. Also this many digits after the comma will be saved for every decimal value, in the document.
Position 2 is a char Array object defining characters the user wants to use (in a form for example) that are not already present in the document. If this list is not populated, certain characters may be not able to draw properly
Position 3 is a boolean value indicating whether font files should be embedded in the exported file, or simply copied separately to the destination folder.
Position 4 is a string object that contains a path where additional files (e.g font files) needed for the export can be found.
Position 5 is an integer that controls the maximum possible value of an image's bitmap (width x height). Default value is 552960 (a resolution of 768 * 720); If an image (width x height) is larger than this value then the image is scaled down to a value smaller or equal in order to keep the aspect ratio. Set it to 0 in order the default value to be used.
Returns
- bool
True if the command was successfuly completed.
- See Also
ExportScript(string, bool, string[], object[], out string[])
Converts and exports the document to the appropriate format in order to be opened by the vdWeb library.
public bool ExportScript(string filename, bool ExportExternalReferences, string[] lics, object[] parameters, out string[] ExportedFileNames)Parameters
filenamestringThe full filename where the document will be exported to, normally ending in a .vds suffix.
ExportExternalReferencesboolSet it to true in order all external references of this document also to be exported.
licsstring[]No need to set lics anymore , contact support@vdraw.com for our new method of licensing.An Arrray of strings containing the licvals to be used with the exported file. These licval codes are used to define the location from where the files will be loaded. For more info contact support@vdraw.com
parametersobject[]An object Array that defines various parameters used to specify properties of the exportation. Null can be used and default properties will be used (for the whole parameter or specific elements of the array).
Position 0 of parameters Array is a vdPrimariesList object defining objects from the document that normally would be purged, but the user wants to keep (such as empty layers).
Position 1 is the decimal precision, meaning an integer value defining how many decimal points will be considered for equality comparisons. Also this many digits after the comma will be saved for every decimal value, in the document.
Position 2 is a char Array object defining characters the user wants to use (in a form for example) that are not already present in the document. If this list is not populated, certain characters may be not able to draw properly
Position 3 is a boolean value indicating whether font files should be embedded in the exported file, or simply copied separately to the destination folder.
Position 4 is a string object that contains a path where additional files (e.g font files) needed for the export can be found.
Position 5 is an integer that controls the maximum possible value of an image's bitmap (width x height). Default value is 552960 (a resolution of 768 * 720);
If an image (width x height) is larger than this value then the image is scaled down to a value smaller or equal in order to keep the aspect ratio. Set it to 0 in order the default value to be used.
ExportedFileNamesstring[]Contrains the list of exported file names.The first one is the basic drawing and the others are external reference scripts
Returns
- bool
True if successfully exported.
Remarks
The following vdFigure types are fully supported
vdLine vdText vdRect vdCircle vdEllipse vdArc vdImage vdInsert vd3DFace vdPolyface vdAttrib vdAttribDef vdInfinityLine vdPoint
The following vdFigure types are limited supported
vdPolyline when HasWidths is exploded to sub entities Explode() and converted to VectorDraw.Professional.vdPrimaries.vdProxyFigure PolyCurves are reconstructed to their filled regions defining them as array of sample points GetOutlineCountours(int, double) vdMText if it is contains character instructions is exploded to sub entities Explode() and converted to VectorDraw.Professional.vdPrimaries.vdProxyFigure vdViewport is exported as a single rectangle the ClipObjis not supported. vdHelix , vdMultiline , vdArcAlignedText , vdDimension , vdGroundSurface , vdLeader and user custom objects VectorDraw.Professional.vdPrimaries.vdProxyFigure are exploded to sub entities Explode() and converted to VectorDraw.Professional.vdPrimaries.vdProxyFigure
The DimStyles , MultilineStyles , Groups , UserTables , NamedUCSs , Views , ProxyClasses
ExportScript(string, ExportScriptFlags, uint, char[], int, vdPrimariesList)
Converts and exports the document to the appropriate format in order to be opened by the vdWeb library.
public bool ExportScript(string filename, vdDocument.ExportScriptFlags flags, uint decimalPrecision, char[] ExtraUsedChars, int maxImageSize, vdPrimariesList extraKeepPrimaries)Parameters
filenamestringThe full filename where the document will be exported to, normally ending in a .vds suffix.
flagsvdDocument.ExportScriptFlagsvdDocument.ExportScriptFlags that controls some exported parameters
decimalPrecisionuintthe decimal precision, meaning an integer value defining how many decimal points will be considered for equality comparisons. Also this many digits after the comma will be saved for every decimal value, in the document.
ExtraUsedCharschar[]A char Array object defining characters, that are not already present in the document, and the user wants to use in the javascript webcontrol when adding new text objects.
maxImageSizeintAn integer that controls the maximum possible value of an image's bitmap (width x height). Default value is 552960 (a resolution of 768 * 720); If an image (width x height) is larger than this value then the image is scaled down to a value smaller or equal in order to keep the aspect ratio. Set it to 0 in order the default value to be used.
extraKeepPrimariesvdPrimariesListA vdPrimariesList collection contains objects from the document that normally would be purged, but the user wants to keep, such as empty layers or no used blocks.
Returns
- bool
True if successfully exported.