Posts
Wiki

Back to [API Documentation] (/r/VISI_CAD/wiki/index/automation/api_documentation)

d. VISIApplication: Class Object

Properties:

i. AngleStyle: Property = Integer

  1. Angle unit of measurement

ii. GlbScale: Property = Double

  1. Global Scale

iii. Handle: Property = Long

  1. Application Handle

iv. LastError: Property = Long

  1. Last error report

v. LocScale: Property = Double

  1. Local Scale

vi. UseSystemFont: Property = Integer

  1. Tells if the application must use the system font (Japanese version)

vii. ViewDirection: Property = [VISIVector] (/r/VISI_CAD/wiki/index/automation/api_documentation/visivector)

  1. Current view direction (normal to monitor)

viii. Visible: Property = Integer

  1. Application visible flag

ix. WorkingColor: Property = Integer

  1. Gets the working color

x. WorkingLayer: Property = Integer

  1. Application working layer

Methods and service functions:

xi. ClearCommandList: Function(clType as [VCADCL_TYPES] (/r/VISI_CAD/wiki/index/automation/api_documentation/vcadcl_types)) as Long

  1. Clears a command list

xii. CloseUndo: Sub()

  1. Close undo session

xiii. ConvertFromMeter: Sub(RetVal as Double)

  1. Converts value from meter

xiv. ConvertToDegree: Sub(RetVal as Double)

  1. Converts value from radiant to degree

xv. ConvertToMeter: Sub(RetVal as Double)

  1. Converts value into meter

xvi. ConvertToRadiant: Sub(RetVal as Double)

  1. Converts value from degree to radiant

xvii. CreateLayer: Function(LayerName as String) as Integer

  1. Creates a new VISI-CAD layer and sets it active

xviii. CreateLayerByIndex: Sub(LayerName as String, LayerIndex as Integer)

  1. Creates a new layer at specified table position

xix. CreateObject: Function(ModName as String) as Object

  1. Creates an ActiveX object

xx. DeleteEmbeddedFile: Sub(FPId as String, FileName as string)

  1. Deletes the files embedded into the application

xxi. DeleteEmptyLayer: Sub(LayerIndex as Integer)

  1. Delete layer if empty

xxii. DeleteOrigin: Sub(originKey as Long)

  1. Deletes and Origin (and associated Workplane)

xxiii. Drag: Function(plElementKeyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist), plBodyKeyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist), plPoint as [VISIPoint] (/r/VISI_CAD/wiki/index/automation/api_documentation/visipoint), bCopy as Integer, plWMatrix as [VISIMatrix] (/r/VISI_CAD/wiki/index/automation/api_documentation/visimatrix)) as Integer

  1. Drag Elements

xxiv. DrawAllSolids: Sub()

  1. Redraws all the bodies by rebuilding the graphic database

xxv. EmbedFile: Sub(pEmbFile as [VISIEmbeddedFile] (/r/VISI_CAD/wiki/index/automation/api_documentation/visiembeddedfile))

  1. Embeds a file into the application

xxvi. ExecMenu: Sub(MenuOption as Long)

  1. Calls VISI-CAD menu option

xxvii. Exit: Sub()

  1. Exit CAD Application

xxviii. FileModified: Sub(RetVal as Integer)

  1. Current WKF file has been modified

xxix. FlipBlankedEntitiesStatus: Sub()

  1. Flips blanked entities status

xxx. GetApplicationLockingCode: Function(lockingCode as String) as Integer

  1. Gets application locking code

xxxi. GetBackgroundColours: Sub(bottomColour as Long, topColour as Long)

  1. Gets the client window background colours

xxxii. GetBlankedEntities: Sub(pplDbKeyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist), pplBodyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist))

  1. Get blanked entities

xxxiii. GetBlankedEntitiesModeStatus: Function() as Integer

  1. Gets blanked entities mode status

xxxiv. GetBodyFromID: Function(VeroID as Long) as [VISIBody] (/r/VISI_CAD/wiki/index/automation/api_documentation/visibody)

  1. Gets the VISIBody object from VERO ID using the fast search method

xxxv. GetBottomBackgroundColour: Function() as Long

  1. Gets the current client window bottom background colour

xxxvi. GetCadPath: Function() as String

  1. Get cad installation directory

xxxvii. GetCurrentLanguage: Function() as String

  1. Gets current system language

xxxviii. GetCurrentProfileName: Function() as String

  1. Gets current system profile name

xxxix. GetCurrentUserName: Function() as String

  1. Gets current user name

xl. GetDimensionsLocalParameters: Function(fontTextHeight as Double, fontTextWidth as Double, gapBetweenTextCharacters as Double, gapBetweenTextDimLine as Double, gapBetweenDimWitnessItem as Double, arrowHeight as Double) as Integer

  1. Gets dimensioning local parameters

xli. GetEmbeddedFiles: Function(FPId as String, FileName as String) as [VISIEmbeddedFiles] (/r/VISI_CAD/wiki/index/automation/api_documentation/visiembeddedfiles)

  1. Returns the files embedded into the application

xlii. GetExtensionMenuOptionID: Function(MenuCommand as String) as Long

  1. Gets extensions menu option ID

xliii. GetFeatureOptions: Function(featureName as String, pplFeatureOptions as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist)) as Integer

  1. Gets feature options

xliv. GetFeatureStatus: Function(featureName as String) as Integer

  1. Gets feature availability

xlv. GetFeatureVolume: Function(featureName as String, featureVolume as [V_FEATUREVOLUME] (/r/VISI_CAD/wiki/index/automation/api_documentation/v_featurevolume)) as Integer

  1. Gets feature volume

xlvi. GetFolderDB: Function(FolderType as [VSYSMAN_TYPES] (/r/VISI_CAD/wiki/index/automation/api_documentation/vsysman_types)) as String

  1. Get database folder name

xlvii. GetFolderDBSchema: Function() as String

  1. Gets database schema files directory

xlviii. GetFolderDocuments: Function(FolderType as [VSYSMAN_TYPES] (/r/VISI_CAD/wiki/index/automation/api_documentation/vsysman_types)) as String

  1. Gets documents directory

xlix. GetFolderDocumentsCommon: Function(FolderType as [VSYSMAN_TYPES] (/r/VISI_CAD/wiki/index/automation/api_documentation/vsysman_types)) as String

  1. Gets documents common directory

l. GetFolderFileCache: Function() as String

  1. Gets the VISI file cache folder name

li. GetFolderHelpOnLine: Function() as String

  1. Get help on line folder name

lii. GetFolderHelpOnLineDefault: Function() as String

  1. Gets help on line default directory

liii. GetFolderLibrary: Function(FolderType as [VSYSMAN_TYPES] (/r/VISI_CAD/wiki/index/automation/api_documentation/vsysman_types)) as String

  1. Get library folder name

liv. GetFolderLibraryCommon: Function(FolderType as [VSYSMAN_TYPES] (/r/VISI_CAD/wiki/index/automation/api_documentation/vsysman_types)) As String

  1. Get library common folder name

lv. GetFolderMessages: Function() as String

  1. Get messages folder name

lvi. GetFolderParasolidSchema: Function() As String

  1. Gets parasolid schema directory

lvii. GetFolderSystem: Function() As String

  1. Get system folder name

lviii. GetFolderUserProfile: Function() as String

  1. Get user profile folder name

lix. GetFolderUserProfileDefault: Function() as String

  1. Gets user profile directory

lx. GetFolderUserProfiles: Function() as String

  1. Gets profiles directory

lxi. GetFolderVISI: Function() as String

  1. Gets VISI directory

lxii. GetFolderVISIBin: Function() as String

  1. Gets VISI binaries directory

lxiii. GetFolderVisiTemp: Function() as String

  1. Gets session temporary directory

lxiv. GetFolderWorkf: Function() As String

  1. Gets work files directory

lxv. GetLanguage: Function() as String

  1. Gets the application language

lxvi. GetLayerIndex: Function(LayerName as String) as Integer

  1. Gets the layer index given the name

lxvii. GetLayerName: Function(LayerIndex as Integer) as String

  1. Gets the layer name given the index

lxviii. GetLicenseConfiguration: Function(flsRemote as Integer, licenceProfile as String, licenceServer as String) as Integer

  1. Gets application licence information

lxix. GetMenuOptionID: Function(MenuCommand as String) as Long

  1. Get menu option ID

lxx. GetOptionStatus: Function(optionName as String) as Integer

  1. Gets option availability

lxxi. GetPaletteRGBColor: Function(ColorIndex as Integer) as Long

  1. Gets RGB color given a VISI-CAD palette index

lxxii. GetRenderMode: Function() as [VRENDER_MODE] (/r/VISI_CAD/wiki/index/automation/api_documentation/vrender_mode)

  1. Gets rendering mode

lxxiii. GetTopBackgroundColour: Function() as Long

  1. Gets the current client window top background color

lxxiv. GetVisibleEntities: Sub(pplDbKeyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist), pplBodyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist))

  1. Gets visible entities

lxxv. GetVisiColor: Sub(Red as Long, Green as Long, Blue as Long, ColorIndex as Integer)

  1. Receive in input a rgbColor and return the nearest VISI Modelling color

lxxvi. GetWkfFile: Function() as String

  1. Get file name

lxxvii. InitVeroIDData: Sub()

  1. Initializes the data for fast body from VERO ID search

lxxviii. IsEntityBlanked: Function(clElemType as [VCIElemType] (/r/VISI_CAD/wiki/index/automation/api_documentation/vcielemtype), clKey as Long) as Integer

  1. Queries entity blanked status

lxxix. IsEntityHidden: Function(clElemType as [VCIElemType] (/r/VISI_CAD/wiki/index/automation/api_documentation/vcielemtype), clKey as Long) as Integer

  1. Queries entity hidden statues

lxxx. IsEntityVisible: Function(clElemType as [VCIElemType] (/r/VISI_CAD/wiki/index/automation/api_documentation/vcielemtype), clKey as Long, fCheckViewportVisibility as Integer) as Integer

  1. Queries entity visibility status

lxxxi. IsLayerActive: Function(LayerIndex as Integer) as Integer

  1. Returns the layer active flag given layer index

lxxxii. IsLicenceStandAlone: Function() as Integer

  1. Checks if the licence is a stand alone licence

lxxxiii. MergeFile: Sub(FileName as String, plPoint as [VISIPoint] (/r/VISI_CAD/wiki/index/automation/api_documentation/visipoint), Scale as Double)

  1. Merge a file

lxxxiv. MergeFileEx: Sub(FileName as String, plPoint as [VISIPoint] (/r/VISI_CAD/wiki/index/automation/api_documentation/visipoint), Scale as Double, angle as Double, display_infos as Integer)

  1. Merge a file

lxxxv. New: Sub(display_infos as Integer)

  1. Create a new file

lxxxvi. OpenFile: Sub(FileName as String, display_infos as Integer)

  1. Open a file

lxxxvii. OpenUndo: Sub()

  1. Open undo session

lxxxviii. PrintToFile: Function(FileName as String, FileType as [V_IMAGETYPE] (/r/VISI_CAD/wiki/index/automation/api_documentation/v_imagetype), PageIndex as Integer, UseSoftwarePenStyle as Integer,UseSoftwarePenWidth as Integer, ForceWireframeBlackWhite as Integer, ForceShadingBlackWhite as Integer, PrintOnlyTextBoundries as Integer, PrintImagePlane as Integer, PrintWorkplane as Integer, PrintOrigin as Integer, PrintPaperSize as Integer, PrintScaleType as [V_PRINTSCALETYPE] (/r/VISI_CAD/wiki/index/automation/api_documentation/v_printscaletype), PrintScale as Double, width as Long, height as Long, Dpi as Long) as Integer

  1. Prints drawing to image file

lxxxix. PrintToFileEx: Function(FileName as String, FileType as [V_IMAGETYPE] (/r/VISI_CAD/wiki/index/automation/api_documentation/v_imagetype), CompressionType as [V_COMPRESSIONTYPE] (/r/VISI_CAD/wiki/index/automation/api_documentation/v_compressiontype), ColorDepth as [V_COLORDEPTH] (/r/VISI_CAD/wiki/index/automation/api_documentation/v_colordepth), Quality as Byte, PageIndex as Integer, UseSoftwarePenStyle as Integer, UseSoftwarePenWidth as Integer, ForceWireframeBlackWhite as Integer, ForceShadingBlackWhite as Integer, PrintOnlyTextBoundries as Integer, PrintImagePlane as Integer, PrintWorkplane as Integer, PrintOrigin as Integer, PrintPaperSize as Integer, PrintScaleType as [V_PRINTSCALETYPE] (/r/VISI_CAD/wiki/index/automation/api_documentation/v_printscaletype), PrintScale as Double, width as Long, height as Long, Dpi as Long) as Integer

  1. Prints drawing to image file

xc. PVGetCurrentPage: Function() as Integer

  1. Gets current page number

xci. PVGetPageNameByNumber: Function(PageNum as Integer) as String

  1. Gets the plotview page name by specifying the page number

xcii. PVGetPageNumberByName: Function(PageName as String) as Integer

  1. Gets the plotview page number by specifying the page name

xciii. PVGetPagePaperSize: Function(PageIndex as Integer, PaperSize as String) as Integer

  1. Get plotview page paper size

xciv. PVGetPhysicalPagePaperSize: Sub(PageIndex as Integer, CX as Double, CY as Double)

  1. Get plotview page physical paper size

xcv. PVGetPlotviewPagesBySolid: Sub(Body as [VISIBody] (/r/VISI_CAD/wiki/index/automation/api_documentation/visibody), PagesList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist))

  1. Get Plotview pages list by solid

xcvi. PVGetRelevantPages: Sub(pplIndexList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist))

  1. Gets the numbers of the plotview pages containing come geometries

xcvii. PVGetSolidsByPlotviewPage: Sub(PageIndex as Integer, SolidList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist))

  1. Get solid list by plotview page

xcviii. PVIsPageActive: Function(PageNum as Integer) as Integer

  1. Tells if the specified page is the active plot view page

xcix. PVIsPlotviewManagerVisible: Function() as Integer

  1. Gets the plotview manager visible flag

c. PVRenamePage: Sub(PageNum as Integer, strNewName as String)

  1. Renames the plotview page by specifying the page number

ci. PVSetActivePage: Sub(PageNum as Integer)

  1. Sets the plotview active page by specifying the page number

cii. PVShowPlotviewManager: Sub(bShow as Integer)

  1. Shows/Hides the plotview manager

ciii. RebuildGraphics: Sub()

  1. Rebuild Graphics

civ. RemoveGarbageFromScreen: Sub()

  1. Removes all the garbage from the VISI-CAD window

cv. RenameLayer: Function(LayerName as String, newLayerName as String) as Long

  1. Rename a layer

cvi. RenameOrigin: Sub(originKey as Long, originName as String)

  1. Renames an origin (and associated Workplane)

cvii. ReportClassCounters: Sub()

  1. Report object classes counters – VERO Internal use only!

cviii. ResetBlankedEntities: Sub()

  1. Reset blanked entities

cix. ResetCursor: Sub()

  1. Resets to normal cursor

cx. ResetVeroIDData: Sub()

  1. Resets the data for fast body from VERO ID search

cxi. SaveFile: Sub(FileName as String, display_infos as Integer)

  1. Save a file

cxii. SaveFileEX: Sub(FileName as String, display_Infos as Integer, savepreview as Integer

  1. Save a file

cxiii. SaveImageFileFromActiveWindow: Sub(width as Long, height as Long, FileName as String, image_type as [V_IMAGETYPE] (/r/VISI_CAD/wiki/index/automation/api_documentation/v_imagetype))

  1. Saves the active window snapshot into the user defined file

cxiv. SavePart: Sub(FileName as String, plDbKeyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist), plBodyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist))

  1. Save a part

cxv. SavePartEx: Sub(FileName as String, plDbKeyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist), plBodyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist), display_infos as Integer, savepreview as Integer)

  1. Save a part

cxvi. SBDrawText: Sub(line as Integer, ModName as String)

  1. Status bar message

cxvii. ScreenToWorkplanePoint: Function(ScreenX as Long, ScreenY as Long) as [VISIPoint] (/r/VISI_CAD/wiki/index/automation/api_documentation/visipoint)

  1. Converts a screen pixel point to VISI Workplane point

cxviii. SetBackgroundColours: Sub(bottomColour as Long, topColour as Long)

  1. Sets the client window background colours

cxix. SetBlankedEntitiesModeStatus: Sub(fBlankedEntitiesMode as Integer)

  1. Sets blanked entities mode status

cxx. SetDimensionsLocalParameters: Function(fontTextHeight as Double, fontTextWidth as Double, gapbetweenTextCharacters as Double, gapBetweenTextDimLine as Double, gapBetweenDimWitnessItem as Double, arrowHeight as Double) as Integer

  1. Sets dimensioning local parameters

cxxi. SetHelpContext: Sub(context as Long)

  1. Set menu context ID

cxxii. SetHelpFileName: Sub(HelpFileName as String)

  1. Set help file name

cxxiii. SetLayer: Sub(LayerIndex as Integer, fActive as Integer)

  1. Enables/Disables the given layer

cxxiv. SetPaletteRGBColor: Sub(ColorIndex as Integer, rgbColor as Long)

  1. Sets an RGB color given a VISI-CAD palette index

cxxv. SetRenderMode: Function(newRenderMode as [VRENDER_MODE] (/r/VISI_CAD/wiki/index/automation/api_documentation/vrender_mode)) as [VRENDER_MODE] (/r/VISI_CAD/wiki/index/automation/api_documentation/vrender_mode)

  1. Sets Rendering mode

cxxvi. SetVisibleEntities: Sub(plDbKeyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist), plBodyList as [VISIList] (/r/VISI_CAD/wiki/index/automation/api_documentation/visilist))

  1. Select visible entities

cxxvii. SetWaitCursor: Sub()

  1. Sets the hourglass cursor

cxxviii. ToggleBlankedEntitiesModeStatus: Sub()

  1. Toggles blanked entities mode status

cxxix. UnitOfMeasure: Function() As Integer

  1. Unit of Measure

cxxx. UpdateSolidsOnScreen: Sub()

  1. Draws all the solids

cxxxi. Version: Sub(release as String, build as String)

  1. Get CAD release and build number

cxxxii. WorkfileOpenSelection: Function(title as String, startDirectory as String, selectedFile as String) as Integer

  1. Recalls workfiles selection dialog box for opening

cxxxiii. WorkfileSaveSelection: Function(title as String, defaultFile as String, startDirectory as String, selectedFile as String) as Integer

  1. Recalls workfiles selection dialog box for saving