ActiveFile
ActiveFile.ACSPlaneSnap
ActiveFile.ActiveAngle
ActiveFile.AngleLock
ActiveFile.Association
ActiveFile.Author
ActiveFile.AuthoringProductName
ActiveFile.AxisLock
ActiveFile.Client
ActiveFile.Comments
ActiveFile.Company
ActiveFile.ConnectProjectGUID
ActiveFile.CreateDate
ActiveFile.DesignRevisionCount
ActiveFile.Editor
ActiveFile.FileName
ActiveFile.FileSize
ActiveFile.Format
ActiveFile.FormatMajorVersion
ActiveFile.FormatMinorVersion
ActiveFile.GraphicGroupLock
ActiveFile.Increment
ActiveFile.KeyPointDevisor
ActiveFile.Keywords
ActiveFile.LastSavedBy
ActiveFile.LevelLock
ActiveFile.Levels
ActiveFile.LevelsUsed
ActiveFile.Manager
ActiveFile.Models
ActiveFile.Orientation
ActiveFile.OriginalFileFormat
ActiveFile.ProjectAssetType
ActiveFile.ProjectIndustry
ActiveFile.ProjectLocation
ActiveFile.ProjectName
ActiveFile.ProjectNumber
ActiveFile.ProjectStatus
ActiveFile.Property__x0020__Label
ActiveFile.Property__x0020__Label__x002D__1
ActiveFile.RevisionNumber
ActiveFile.SaveDate
ActiveFile.ScaleLock
ActiveFile.ScaleTolerance
ActiveFile.SnapLock
ActiveFile.SnapMode
ActiveFile.StartAngle
ActiveFile.Subject
ActiveFile.Title
ActiveFile.Tolerance
ActiveFile.TotalEditingTime
ActiveFile.WorkSetDescription
ActiveFile.WorkSetName
ActiveFile.WorkSpaceName
ActiveFile.XActiveScale
ActiveFile.YActiveScale
ActiveFile.ZActiveScale
ActiveLock
ActiveLock.AngleLockEnabled ()
ActiveLock.AnnotationScaleLockEnabled ()
ActiveLock.AssociationLockEnabled ()
ActiveLock.AxisLockEnabled ()
ActiveLock.ConstructionPlaneLockEnabled ()
ActiveLock.ElementTemplateAssociationEnabled ()
| Example | Result |
| ActiveLock.ElementTemplateAssociationEnabled() | False |
ActiveLock.GraphicGroupLockEnabled ()
ActiveLock.GridLockEnabled ()
ActiveLock.IsometricLockEnabled ()
ActiveLock.LevelLockEnabled ()
ActiveLock.PatternAssociationLockEnabled ()
ActiveLock.SnapLockEnabled ()
ActiveLock.TextNodeLockEnabled ()
ActiveLock.UnitLockEnabled ()
ActiveModel
ActiveModel.Accuracy
ActiveModel.ACSPlane
ActiveModel.AngleReadoutAccuracy
ActiveModel.AngleReadoutFormat
ActiveModel.AnnotationScale
ActiveModel.CanbePlacedAsAnnotationCell
ActiveModel.CanbePlacedAsCell
ActiveModel.CellType
ActiveModel.DefaultRefLogical
ActiveModel.Description
ActiveModel.DesignScale
ActiveModel.Direction
ActiveModel.DirectionBase
ActiveModel.DirectionMode
ActiveModel.Format
ActiveModel.GlobalLineStyleScaleFactor
ActiveModel.GridAspect
ActiveModel.GridConfig
ActiveModel.GridLock
ActiveModel.GridMaster
ActiveModel.GridReference
ActiveModel.Hidden
ActiveModel.Is3D
ActiveModel.IsActive
ActiveModel.IsMarkup
ActiveModel.IsMaster
ActiveModel.IsometricLock
ActiveModel.IsometricPlane
ActiveModel.LineStyleScale
ActiveModel.MasterUnit
ActiveModel.MasterUnitLabel
ActiveModel.ModelId
ActiveModel.Name
ActiveModel.PaperScale
ActiveModel.PropagateAnnotationScale
ActiveModel.Resolution
ActiveModel.SolidAccuracy
ActiveModel.SolidArea
ActiveModel.SubUnit
ActiveModel.SubUnitLabel
ActiveModel.TreatAs3D
ActiveModel.Type
ActiveModel.UpdateFieldsAutomatically
ActiveModel.WorkingArea
ActiveView
ActiveView.DisplayStyleName ()
ActiveView.ShowACSTriad ()
ActiveView.ShowBackground ()
ActiveView.ShowBoundayDisplay ()
ActiveView.ShowConstructionClass ()
ActiveView.ShowDataFields ()
ActiveView.ShowDimensionClass ()
ActiveView.ShowFastCells ()
ActiveView.ShowFastCurves ()
ActiveView.ShowFill ()
ActiveView.ShowGrid ()
ActiveView.ShowLineStyles ()
ActiveView.ShowLineWeight ()
ActiveView.ShowPatternBumpMaps ()
ActiveView.ShowTags ()
ActiveView.ShowText ()
ActiveView.ShowTextNodes ()
ActiveView.ShowTransparency ()
ActiveView.UseCamera ()
ActiveView.UseClipBack ()
ActiveView.UseClipFront ()
ActiveView.UseClipVolume ()
ActiveView.UseDefaultLighting ()
ActiveView.UseDisplaySet ()
ActiveView.UseLevelOverrides ()
ActiveView.UsesClipVolumeElement ()
Application.ProductID
Application.ProductID.GetID ()
| Example | Result |
| Application.ProductID.GetID() | 10 |
BCGC
BCGC.IsMethodActive (methodName)
| Name | Type | Description |
| methodName | String |
BCOUIC
BCOUIC.IsMethodActive (methodName)
| Name | Type | Description |
| methodName | String |
BCUIT
BCUIT.IsItemChecked (cmdStr)
| Name | Type | Description |
| cmdStr | String |
BCUIT.IsItemEnabled (cmdStr)
| Name | Type | Description |
| cmdStr | String |
BCUIT.IsItemVisible (cmdStr)
| Name | Type | Description |
| cmdStr | String |
BCUIT.IsMenuVisible (cmdStr)
| Name | Type | Description |
| cmdStr | String |
BCUIT.IsSeparatorVisible (cmdStr)
| Name | Type | Description |
| cmdStr | String |
BCUIT.IsToolBoxVisible (cmdStr)
| Name | Type | Description |
| cmdStr | String |
Clipboard
Clipboard.IsCopyValid ()
Clipboard.IsCutValid ()
Clipboard.IsPasteValid ()
ConfigVar
ConfigVar.ExpandConfigVar (variable)
| Name | Type | Description |
| variable | String |
| Example | Result |
| ConfigVar.ExpandConfigVar("MS_SETTINGSDIR = $(MS_SETTINGSDIR)") | MS_SETTINGSDIR = c:\Mstn\Bentley\MicroStation\Default\data\ |
ConfigVar.GetExpandedConfigVar (variable)
| Name | Type | Description |
| variable | String |
| Example | Result |
| ConfigVar.GetExpandedConfigVar("MS_SETTINGSDIR") | current expansion of MS_SETTINGSDIR |
ConfigVar.GetUnexpandedConfigVar (variable)
| Name | Type | Description |
| variable | String |
| Example | Result |
| ConfigVar.GetUnexpandedConfigVar("MS_SETTINGSDIR") | current expansion of MS_SETTINGSDIR |
ConfigVar.IsConfigVarDefined (variable)
| Name | Type | Description |
| variable | String |
| Example | Result |
| ConfigVar.IsConfigVarDefined("MS_FILEHISTORY") | True |
CustomProperties
CustomProperties.CanDeleteFromActiveFile
CustomProperties.CanDeleteFromElement (ElementId)
| Name | Type | Description |
| ElementId | string |
CustomProperties.CanDeleteFromModel (ModelId)
| Name | Type | Description |
| ModelId | string |
DesignHistory
DesignHistory.CanCheckForChanges ()
DesignHistory.CanCommit ()
DesignHistory.CanCreate ()
DesignHistory.CanDelete ()
DesignHistory.HasHistory ()
ECObjects
ECObjects.GetClass ()
| Example | Result |
| SelectedElement.GetClass().Name | Room |
ECObjects.GetInstanceId ()
| Example | Result |
| SelectedElement.GetInstanceId() | {A5048D2F-A021-43f4-A0C9-90E58BBDF2AF} |
ECObjects.GetInstanceLabel ()
| Example | Result |
| SelectedElement.GetInstanceLabel() | Room: r1.04 (restrooms) |
ECObjects.GetRelatedInstance (RelatedInstanceAccessor)
| Name | Type | Description |
| RelatedInstanceAccessor | string |
| Example | Result |
| SelectedElement.GetRelatedInstance("PersonToFather:0:Person") |
ECObjects.IsOfClass (className,schemaName)
| Name | Type | Description |
| className | string | |
| schemaName | string |
| Example | Result |
| SelectedElement.IsOfClass("Room", "ExampleSchema.01.00") | true |
ECReporting
ECReporting.CanConvertSearchNodeToReportDefinition
MenuMark
MenuMark.Check
MenuMark.FilledCircle
MenuMark.None
MenuMark.OpenCircle
MenuMark.RightArrow
MiniToolbar
MiniToolbar.IsHoverElementSelected
SelectedNodes
SelectedNodes.AreGroupingNodes
SelectedNodes.AreItemsGraphical
SelectedNodes.AreItemsGraphicalElements
SelectedNodes.AreObjectNodes
SelectedNodes.CanBeRenamed
SelectedNodes.CanLevelsBeTurnedOnOff
SelectedNodes.FullPathToLibraryFile
SelectedNodes.FullPathToReference
SelectedNodes.GetPropertyOfInstance
SelectedNodes.GetPropertyOfSelectedNodes
SelectedNodes.IsActiveModelReference
SelectedNodes.IsAnyParentNamedView
SelectedNodes.IsClipBoardEmpty
SelectedNodes.IsDetailsSelection
SelectedNodes.IsDGNWSFileReadOnly
SelectedNodes.IsEmbeddedReference
SelectedNodes.IsIn3dModel
SelectedNodes.IsInActiveModelOrReference
SelectedNodes.IsInLibraryFile
SelectedNodes.IsInLibraryModel
SelectedNodes.IsInMasterModel
SelectedNodes.IsInReferenceModel
SelectedNodes.IsInstanceReadOnly
SelectedNodes.IsMainSelection
SelectedNodes.IsNodeTypeDrawingOrReferenceLink
SelectedNodes.IsOfClass
SelectedNodes.IsParentActiveModel
SelectedNodes.IsPropertyReadOnly
SelectedNodes.IsSearchResultsNode
SelectedNodes.IsWorkSetLinkTree
SelectedNodes.NodesCount
SelectedNodes.NodesLabelQuotedAndCommaSeperated
SelectedNodes.NodesLabelQuotedWithSlashedQuotes
SelectedNodes.NodesLabels
SelectedNodes.NodesLabelsQuoted
SelectedNodes.NodesParentLabel
SelectedNodes.NodesParentNamedViewName
SelectedNodes.NodesParentParentType
SelectedNodes.NodesParentType
SelectedNodes.NodesThirdParentType
SelectedNodes.NodesType
SelectedNodes.ParentExistsOfType
SelectedNodes.PathToLevels
SelectedNodes.PathToReference
SelectedNodes.ReferenceActivationPermitted
SelectedNodes.RefNodeFullPath
SelectedNodes.SelectedNodeElementId
SelectedNodes.SelectedNodeLinkDescriptor
SelectedNodes.SelectedNodeModelId
SelectedNodes.TreeType
Selection
Selection.AllowsScaling ()
| Example | Result |
| Selection.AllowsScaling() AND Selection.ContainsSingleElement() AND Selection.OnlyContainsActiveModelElements() | True or False, Depending on Selected Elements |
Selection.AllowsUngroup ()
| Example | Result |
| Selection.AllowsScaling() AND Selection.ContainsSingleElement() AND Selection.OnlyContainsActiveModelElements() | True or False, Depending on Selected Elements |
Selection.ContainsEditableText ()
| Example | Result |
| Selection.ContainsSingleElement() AND Selection.ContainsEditableText() | True or False, Depending on Selected Elements |
Selection.ContainsElementDescription (typeDescription)
| Name | Type | Description |
| typeDescription | String |
Selection.ContainsElementFromCategory (category)
| Name | Type | Description |
| category | Int32 |
|
Selection.ContainsElementOnLevel (levelName)
| Name | Type | Description |
| levelName | String |
| Example | Result |
| Selection.ContainsElementOnLevel("Default") | Varies based on selected element(s) |
Selection.ContainsElementType (typeDescription)
| Name | Type | Description |
| typeDescription | String |
| Example | Result |
| Selection.ContainsElementType("Line") | Varies based on selected element(s) |
Selection.ContainsFillableArea ()
| Example | Result |
| Selection.ContainsSingleElement() AND Selection.ContainsFillableArea() | True or False, Depending on Selected Elements |
Selection.ContainsHandlerClass (className)
| Name | Type | Description |
| className | String |
Selection.ContainsPath ()
| Example | Result |
| Selection.ContainsPath() AND (Selection.ContainsSingleElement()) AND Selection.OnlyContainsActiveModelElements() | True or False, Depending on Selected Elements |
Selection.ContainsReferencedElement ()
| Example | Result |
| Selection.ContainsSingleElement() AND Selection.ContainsReferencedElement() | True or False, Depending on Selected Elements |
Selection.ContainsSingleElement ()
| Example | Result |
| Selection.AllowsScaling() AND Selection.ContainsSingleElement() AND Selection.OnlyContainsActiveModelElements() | True or False, Depending on Selected Elements |
Selection.ContainsText ()
| Example | Result |
| Selection.ContainsSingleElement() AND Selection.ContainsText() | True or False, Depending on Selected Elements |
Selection.GetElementLevelName ()
| Example | Result |
| IIF (Selection.ContainsSingleElement(), Selection.GetElementLevelName(), "Ambiguous") | Varies based on selected element(s) |
Selection.GetHandlerClass ()
| Example | Result |
| IIF (Selection.ContainsSingleElement(), Selection.GetHandlerClass(), "Unknown") | Varies based on selected element(s) |
Selection.IsActive ()
| Example | Result |
| Selection.IsActive() | True or False, Depending on Selected Elements |
Selection.IsClipVolumeElement ()
| Example | Result |
| Selection.ContainsSingleElement() AND Selection.IsClipVolumeElement() | True or False, Depending on Selected Elements |
Selection.NumElementsSelected ()
Selection.OnlyContainsActiveModelElements ()
| Example | Result |
| Selection.AllowsScaling() AND Selection.ContainsSingleElement() AND Selection.OnlyContainsActiveModelElements() | True or False, Depending on Selected Elements |
Session
Session.ActiveAnnotationScale ()
Session.ActiveCommandKeyin ()
| Example | Result |
| Session.ActiveCommandKeyin() | CHOOSE ELEMENT |
Session.ActiveFileAllowsExports ()
Session.ActiveFileAllowsPrinting ()
Session.ActiveFileIsAConfiguredDgnlib ()
Session.ActiveFileIsScratch ()
Session.ActiveModelIs3D ()
| Example | Result |
| "This is a " & IIF(Session.ActiveModelIs3D(),"3D model", "2D model") | This is a 2D model |
Session.ActiveModelIsMarkup ()
Session.ActiveModelIsReference ()
Session.ActiveModelTypeIsDesign ()
Session.ActiveModelTypeIsDrawing ()
Session.ActiveModelTypeIsSheet ()
Session.ActiveSnapMode ()
| Example | Result |
| 2=Session.ActiveSnapMode () | Returns True if Active Snap Mode is Keypoint |
Session.ActiveTaskType ()
| 0 | No specific task. |
| 1 | Drawing on a plane in 2d or 3d model. |
| 2 | 3D modeling and design. |
| 3 | Photo realistic rendering. |
| 4 | Animating elements. |
| 5 | Composing design models (backgrounds, assemblies, etc). |
| 6 | Working in a sheet model to compose a drawing. |
| 7 | Review and Navigation |
| 8 | Redline |
| 9 | Administration and configuration |
| 10 | Generative Components |
| Example | Result |
| Session.ActiveTaskType()=0 | True |
Session.ActiveWorkflow ()
| Example | Result |
| Session.ActiveWorkflow() | Drawing |
Session.ActiveWorkflowName ()
| Example | Result |
| Session.ActiveWorkflowName() | Mstn.Drawing |
Session.DefaultSnapMode ()
| Example | Result |
| 2=Session.DefaultSnapMode () | Returns True if Default Snap Mode is Keypoint |
Session.EvalCExprAsBool (cexpr,taskId)
| Name | Type | Description |
| cexpr | String | |
| taskId | String |
| Example | Result |
| Session.EvalCExprAsBool("tcb->msToolSettings.general.useFence","") | False |
Session.EvalCExprAsDouble (cexpr,taskId)
| Name | Type | Description |
| cexpr | String | |
| taskId | String |
| Example | Result |
| Session.EvalCExprAsDouble("tcb->actangle", "") | 1 |
Session.EvalCExprAsInt (cexpr,taskId)
| Name | Type | Description |
| cexpr | String | |
| taskId | String |
| Example | Result |
| Session.EvalCExprAsInt("tcb->msToolSettings.igen.placeEllipseMode", "") | 1 |
Session.EvalCExprAsString (cexpr,taskId)
| Name | Type | Description |
| cexpr | String | |
| taskId | String |
| Example | Result |
| Session.EvalCExprAsString("tcb->dgnfilenm", "") | C:\Mstn\Bentley\WorkSpace\Projects\Examples\General\dgnlib\general.dgnlib |
Session.EvalNEAsBool (expression,default)
| Name | Type | Description |
| expression | String | |
| default | Boolean |
Session.EvalNEAsDouble (expression,default)
| Name | Type | Description |
| expression | String | |
| default | Double |
Session.EvalNEAsInt (expression,default)
| Name | Type | Description |
| expression | String | |
| default | Integer |
Session.EvalNEAsString (expression,default)
| Name | Type | Description |
| expression | String | |
| default | String |
Session.GetFeatureAspectId (featureAspectName)
| Name | Type | Description |
| featureAspectName | String |
| Example | Result |
| Session.IsFeatureAspectAllowed(Session.GetFeatureAspectId("Animation")) | True |
Session.GetSnapModeMenuMark (snapMode)
| Name | Type | Description |
| snapMode | Int32 |
| Example | Result |
| Session.GetSnapModeMenuMark (SnapMode.Keypoint) | Returns 0 for no mark, 3 for open circle (default snap mode), 4 for solid circle (active snap mode). |
Session.GetUIItemStateMenuMark (key)
| Name | Type | Description |
| key | String |
| Example | Result |
| Session.GetUIItemStateMenuMark("MyItem.Key") | int value |
Session.IsAccuSnapEnabled ()
| Example | Result |
| Session.IsAccuSnapEnabled () | Returns True if AccuSnap is Enabled |
Session.IsActiveFileInCfgVarList (cfgvar)
| Name | Type | Description |
| cfgvar | String |
| Example | Result |
| Session.IsActiveFileInCfgVarList("MS_DGNLIBLIST") | True or False |
| Session.IsActiveFileInCfgVarList("MS_GUIDGNLIBLIST,_USTN_SYSTEM_GUIDGNLIBLIST") | True or False |
Session.IsCapabilityEnabled (capabilityString)
| Name | Type | Description |
| capabilityString | String |
| Example | Result |
| Session.IsCapabilityEnabled("View_clip") | True or False |
Session.IsConnectClientEnabled ()
| Example | Result |
| Session.IsConnectClientEnabled() | True or False |
Session.IsDisplaySetActive ()
Session.IsDotNetDialogOpen (name)
| Name | Type | Description |
| name | String |
| Example | Result |
| Session.IsDotNetDialogOpen("Element Info") | True |
The symbol Session.IsDotNetDialogOpen also accepts resourceId and task name parameters like the symbol Session.IsMdlDialogOpen.
| Example | Result |
| Session.IsDotNetDialogOpen (116903627,"EVALUATOR") | Returns True if the "Named Expressions" dialog is open. |
Session.IsDwgFile ()
| Example | Result |
| Session.IsDwgFile() | False |
Session.IsDxfFile ()
Session.IsFeatureAspectAllowed (featureAspectId)
| Name | Type | Description |
| featureAspectId | Integer |
| Example | Result |
| Session.IsFeatureAspectAllowed(Session.GetFeatureAspectId("Animation")) | True |
Session.IsMdlDialogOpen (rscId,mdlTaskId)
| Name | Type | Description |
| rscId | Int32 | |
| mdlTaskId | String |
| Example | Result |
| Session.IsMdlDialogOpen(-7, "REF") | True |
Session.IsMdlLoaded (task_name)
| Name | Type | Description |
| task_name | String |
| Example | Result |
| Session.IsMdlLoaded("PSELECT") | True |
Session.IsNamedToolBoxOpen (toolboxPath)
| Name | Type | Description |
| toolboxPath | String |
| Example | Result |
| Session.IsNamedToolBoxOpen("\Drawing\Linear") | False |
| Session.IsNamedToolBoxOpen("Extra Tools") | False |
Session.IsPopsetEnabled ()
| Example | Result |
| Session.IsPopsetEnabled() | False |
Session.IsProductLicensed (product_id,version)
| Name | Type | Description |
| product_id | Int32 | |
| version | String |
| Example | Result |
| Session.IsProductLicensed (1000, "08.11.00.00") | True or False (depending on current license status) |
Session.IsReadOnlyFile ()
| Example | Result |
| Session.IsReadOnlyFile() | False |
Session.IsRedoActive ()
| Example | Result |
| Session.IsRedoActive() | True |
Session.IsSnapModeValid (snapMode)
| Name | Type | Description |
| snapMode | Int32 |
|
| Example | Result |
| Session.IsSnapModeValid (2048) | Returns True if Parallel Snap Mode is a valid Snap Mode |
Session.IsToolBoxOpen (toolboxRscId,mdlTaskId)
| Name | Type | Description |
| toolboxRscId | Int32 | |
| mdlTaskId | String |
| Example | Result |
| Session.IsToolBoxOpen(-548, "MGDSHOOK") | True |
Session.IsToolFrameOpen (toolboxRscId,mdlTaskId)
| Name | Type | Description |
| toolboxRscId | Int32 | |
| mdlTaskId | String |
Session.IsUIItemStateEnabled (key,defaultValue)
| Name | Type | Description |
| key | String | |
| defaultValue | Boolean |
| Example | Result |
| Session.IsUIItemStateEnabled("MyItem.Key", false) | True/False |
Session.IsUIItemStateVisible (key,defaultValue)
| Name | Type | Description |
| key | String | |
| defaultValue | Boolean |
| Example | Result |
| Session.IsUIItemStateVisible("MyItem.Key", false) | True/False |
Session.IsUIItemStateVisible (key,defaultValue)
| Name | Type | Description |
| key | String | |
| defaultValue | Boolean |
| Example | Result |
| Session.IsUIItemStateChecked("MyItem.Key", false) | True/False |
Session.IsUndoActive ()
| Example | Result |
| Session.IsUndoActive() | True |
Session.IsUserLoggedIn ()
| Example | Result |
| Session.IsUserLoggedIn() | True or False |
Session.IsV7DgnFile ()
| Example | Result |
| Session.IsV7DgnFile() | False |
Session.IsV8DgnFile ()
| Example | Result |
| IIF(Session.IsV8DgnFile(),"V8 Dgn File", IIF(Session.IsV7DgnFile(), "V7 Dgn File", IIF(Session.IsDwgFile(), "DWG File", "Unknown File type"))) | V8 Dgn File |
Session.ItemBrowserInBentleyView ()
Session.RedoCommandString ()
| Example | Result |
| Session.RedoCommandString() | Redo PLACE LINE |
Session.TreatActiveModelAs3D ()
Session.UndoCommandString ()
| Example | Result |
| Session.UndoCommandString() | Undo PLACE LINE |
SnapMode
SnapMode.Bisector
SnapMode.Center
SnapMode.Intersection
SnapMode.Keypoint
SnapMode.Midpoint
SnapMode.Multi1
SnapMode.Multi2
SnapMode.Multi3
SnapMode.Nearest
SnapMode.Origin
SnapMode.Parallel
SnapMode.Perpendicular
SnapMode.PerpendicularPoint
SnapMode.PointOn
SnapMode.PointThrough
SnapMode.Tangency
SnapMode.TangentPoint
System.DateTime
System.DateTime.Now ()
System.Environment
System.Environment.CurrentDirectory ()
System.Environment.ExpandEnvironmentVariables (name)
| Name | Type | Description |
| name | String |
| Example | Result |
| System.Environment.ExpandEnvironmentVariables("%SystemRoot%\system32\xcopy.exe") | C:\WINDOWS\system32\xcopy.exe |
System.Environment.GetEnvironmentVariable (variable)
| Name | Type | Description |
| variable | String |
| Example | Result |
| System.Environment.GetEnvironmentVariable("SystemRoot") | C:\WINDOWS |
System.Environment.UserName ()
System.Math
System.Math.Abs (value)
| Name | Type | Description |
| value | Double |
| Example | Result |
| System.Math.Abs(-32.3) | 32.3 |
System.Math.Acos (value)
| Name | Type | Description |
| value | Double |
| Example | Result |
| System.Math.Acos (0.866025403784439) * 180.0/System.Math.PI | 30.0 |
System.Math.Asin (value)
| Name | Type | Description |
| value | Double |
| Example | Result |
| System.Math.Sin (0.5)*180.0/System.Math.PI | 30 |
System.Math.Atan (value)
| Name | Type | Description |
| value | Double |
| Example | Result |
| System.Math.Atan (0.577350269189626) * 180.0/System.Math.PI | 30 |
System.Math.Atan2 (y,x)
| Name | Type | Description |
| y | Double | |
| x | Double |
| Example | Result |
| System.Math.Atan2 (1.0,1.0) * 180.0/System.Math.PI | 45 |
System.Math.BigMul (a,b)
| Name | Type | Description |
| a | Int | |
| b | Int |
System.Math.Ceiling (a)
| Name | Type | Description |
| a | Double |
| Example | Result |
| System.Math.Ceiling(4.25) | 5 |
System.Math.Cos (r)
| Name | Type | Description |
| r | Double |
| Example | Result |
| System.Math.Cos (30.0*System.Math.PI/180.0) | 0.866025403784439 |
System.Math.Cosh (r)
| Name | Type | Description |
| r | Double |
System.Math.E
| Example | Result |
| System.Math.E | 2.71828182845905 |
System.Math.Exp (p)
| Name | Type | Description |
| p | Double |
System.Math.Floor (d)
| Name | Type | Description |
| d | Double |
| Example | Result |
| System.Math.Ceiling(4.25) | 4 |
System.Math.IEEERemainder (x,y)
| Name | Type | Description |
| x | Double | |
| y | Double |
System.Math.Log (r)
| Name | Type | Description |
| r | Double |
The System.Math.Log symbol has the ability to process an additional double argument for that defines the base for the logarithm.
| Example | Result |
| System.Math.Log(1.2) / System.Math.Log(0.1) | -0.0791812460476248 |
| System.Math.Log(1.2, 0.1) | -0.0791812460476248 |
System.Math.Log10 (d)
| Name | Type | Description |
| d | Double |
System.Math.Max (x,y)
| Name | Type | Description |
| x | Double | |
| y | Double |
| Example | Result |
| System.Math.Max(4.25, 4.55) | 4.55 |
System.Math.Min (x,y)
| Name | Type | Description |
| x | Double | |
| y | Double |
| Example | Result |
| System.Math.Min(4.25, 4.55) | 4.25 |
System.Math.PI
| Example | Result |
| System.Math.PI | 3.14159265358979 |
System.Math.Pow (x,y)
| Name | Type | Description |
| x | Double | |
| y | Double |
| Example | Result |
| System.Math.Pow(2, 3) | 8 |
System.Math.Round (value)
| Name | Type | Description |
| value | Double |
The System.Math.Round symbol has the ability to process an additional integer argument for rounding the decimal portion of a floating point value.
| Example | Result |
| System.Math.Round(4.25) | 4 |
| System.Math.Round(4.5) | 4 |
| System.Math.Round(4.501) | 5 |
| System.Math.Round(4.5015,3) | 4.502 |
System.Math.Sin (a)
| Name | Type | Description |
| a | Double |
| Example | Result |
| System.Math.Sin(30.0*System.Math.PI/180.0) | 0.5 |
System.Math.Sinh (a)
| Name | Type | Description |
| a | Double |
System.Math.Sqrt (d)
| Name | Type | Description |
| d | Double |
| Example | Result |
| System.Math.Sqrt(16.0) | 4 |
System.Math.Tan (a)
| Name | Type | Description |
| a | Double |
| Example | Result |
| System.Math.Tan(30.0 * System.Math.PI/180.0) | 0.577350269189626 |
System.Math.Tanh (a)
| Name | Type | Description |
| a | Double |
System.Path
System.Path.Combine (path1,path2)
| Name | Type | Description |
| path1 | String | |
| path2 | String |
System.Path.GetDirectoryName (path)
| Name | Type | Description |
| path | String |
| Example | Result |
| System.Path.GetDirectoryName(System.Environment.ExpandEnvironmentVariables("%SystemRoot%\system32\xcopy.exe")) | xcopy |
System.Path.GetExtension (path)
| Name | Type | Description |
| path | String |
| Example | Result |
| System.Path.GetExtension(System.Environment.ExpandEnvironmentVariables("%SystemRoot%\system32\xcopy.exe")) | xcopy |
System.Path.GetFileName (path)
| Name | Type | Description |
| path | String |
| Example | Result |
| System.Path.GetFileName(System.Environment.ExpandEnvironmentVariables("%SystemRoot%\system32\xcopy.exe")) | xcopy.exe |
System.Path.GetFileNameWithoutExtension (path)
| Name | Type | Description |
| path | String |
| Example | Result |
| System.Path.GetFileNameWithoutExtension(System.Environment.ExpandEnvironmentVariables("%SystemRoot%\system32\xcopy.exe")) | xcopy |
System.Path.GetFullPath (path)
| Name | Type | Description |
| path | String |
| Example | Result |
| System.Path.GetFullPath(System.Environment.ExpandEnvironmentVariables("%SystemRoot%\system32\xcopy.exe")) | C:\WINDOWS\system32\xcopy.exe |
System.String
System.String.Compare (string1,string2)
| Name | Type | Description |
| string1 | String | |
| string2 | String |
| Example | Result |
| System.String.Compare("ABCDEFG", "abcdefg") | False |
System.String.CompareI (string1,string2)
| Name | Type | Description |
| string1 | String | |
| string2 | String |
| Example | Result |
| System.String.CompareI("ABCDEFG", "abcdefg") | True |
System.String.Format (format,arg0)
| Name | Type | Description |
| format | String | |
| arg0 | Object |
The System.String.Format symbol has the ability to process 3 additional objects for formatting. The list below demonstrates how the different arguments are referenced.
| Example | Result |
| System.String.Format("Short date: {0:d}", System.DateTime.Now()) | Short date: 8/6/2008 |
| System.String.Format("Long date: {0:D}", System.DateTime.Now()) | Long date: Wednesday, August 06, 2008 |
| System.String.Format("Short time: {0:t}", System.DateTime.Now()) | Short time: 4:21 PM |
| System.String.Format("General date: {0:G}", System.DateTime.Now()) | General date: 8/6/2008 4:29:08 PM |
| System.String.Format("Long time: {0:T}", System.DateTime.Now()) | Long time: 4:22:39 PM |
| System.String.Format("Custom: {0:dd-MMM-yyyy}", System.DateTime.Now()) | Custom: 06-Aug-2008 |
| System.String.Format("Currency: {0:C}", -123.45) | Currency: ($123.45) |
| System.String.Format("Currency: {0:C}", 123.45) | Currency: $123.45 |
| System.String.Format("Decimal Point: {0:0.000}", 123) | Decimal Point: 123.000 |
| System.String.Format("Decimal Point: {0:0.000}", -123.45) | Decimal Point: -123.450 |
| System.String.Format("Percent: {0:0.000%}", 0.12345) | Percent: 12.345% |
| System.String.Format("Special: {0:(###)###-####}", 8005551212) | Special: (800)555-1212 |
System.String.IndexOf (search,find)
| Name | Type | Description |
| search | String | |
| find | String |
| Example | Result |
| System.String.SubString("ABXCDXEFG", System.String.IndexOf("ABXCDXEFG", "X")+1, -1) | CDXEFG |
System.String.LastIndexOf (search,find)
| Name | Type | Description |
| search | String | |
| find | String |
| Example | Result |
| System.String.SubString("ABXCDXEFG", System.String.LastIndexOf("ABXCDXEFG", "X")+1, -1) | EFG |
System.String.Length (value)
| Name | Type | Description |
| value | String |
| Example | Result |
| System.String.Length("ABCDEFG") | 7 |
System.String.Substring (value,startIndex,length)
| Name | Type | Description |
| value | String | |
| startIndex | Integer | |
| length | Integer |
| Example | Result |
| System.String.SubString("ABCDEFG", 2, 3) | CDE |
| System.String.SubString("ABCDEFG", 3, -1) | DEFG |
System.String.ToLower (value)
| Name | Type | Description |
| value | String |
| Example | Result |
| System.String.ToLower("ABCDEFG") | abcdefg |
System.String.ToString (value)
| Name | Type | Description |
| value | Object |
System.String.ToUpper (value)
| Name | Type | Description |
| value | String |
| Example | Result |
| System.String.ToUpper("abcdefg") | ABCDEFG |
System.String.Trim (value)
| Name | Type | Description |
| value | String |
| Example | Result |
| System.String.Trim(" ABCDEFG ") | ABCDEFG |
Workspace
Workspace.GetProjectName ()
Workspace.GetUserName ()
Workspace.IsReadOnly ()
Workspace.IsWorksetConnected ()