GetGlobalParameter Method

Description

Returns the setting of a specified global parameter for the referenced Application or document object.

Syntax

Visual Basic
Public Sub GetGlobalParameter( _ ByVal Parameter As ApplicationGlobalConstants, _ ByRef Value As Variant _ )

Parameters

Parameter

Value	Description
seApplicationGlobalActivateAllParts	Activate All Parts
seApplicationGlobalAdminFileLocation	AdminFileLocation
seApplicationGlobalANSIInchToleranceFile	ANSI Inch Tolerance File
seApplicationGlobalANSIMetricToleranceFile	ANSI Metric Tolerance File
seApplicationGlobalApplicationDisplay	Application display mode for new windows
seApplicationGlobalApplyActivationOverridesToParts	Apply Activation Overrides To Parts
seApplicationGlobalApplySimplifyOverridesToParts	Apply Simplify Overrides To Parts
seApplicationGlobalApplySimplifyOverridesToSubAssemblies	Apply Simplify Overrides To SubAssemblies
seApplicationGlobalApplyStatusToLinks	Apply Status To Links
seApplicationGlobalAutomaticSave	Automatic Save
seApplicationGlobalAutomaticSaveTime	Automatic Save Time
seApplicationGlobalAutoSharpenLevel	Automatic sharpen level
seApplicationGlobalAvailableRootFolder	Available Root Folder
seApplicationGlobalBaselinedRootFolder	Baselined Root Folder
seApplicationGlobalChangedPartActivation
seApplicationGlobalCheckInOnClose	Check In On Close
seApplicationGlobalColorActive	The color for active elements
seApplicationGlobalColorBackground	The color for the background
seApplicationGlobalColorConstruction	The color for construction elements
seApplicationGlobalColorDisabled	The color for disabled items
seApplicationGlobalColorFailed	The color for failed items
seApplicationGlobalColorHandle	The color for handles
seApplicationGlobalColorHighlight	The color for highlighted elements
seApplicationGlobalColorLiveSectionCenterline
seApplicationGlobalColorLiveSectionEdge
seApplicationGlobalColorLiveSectionOpacity
seApplicationGlobalColorLiveSectionRegion
seApplicationGlobalColorManagerCopyIndividualFaceColors	Color Manager Copy Individual Face Colors
seApplicationGlobalColorManagerShowAssemblyStyleOverrides	Color Manager Show Assembly Style Overrides
seApplicationGlobalColorManagerShowPartFaceColors	Color Manager Show Part Face Colors
seApplicationGlobalColorManagerUseIndividualPartStyles	ColorManager Use Individual Part Styles
seApplicationGlobalColorManagerUseToolsOptionsColorSettings	Color Manager Use Tools Options Color Settings
seApplicationGlobalColorProfile	The color for profiles, sketches and layouts
seApplicationGlobalColorRefPlane	Color RefPlane
seApplicationGlobalColorSelected	The color for items in the select set
seApplicationGlobalColorSheet	The color for the sheet
seApplicationGlobalColorSheetTab1	Specifies the first of two alternating colors for the sheet tabs.
seApplicationGlobalColorSheetTab2	Specifies the second of two alternating colors for the sheet tabs.
seApplicationGlobalCommandBarMode	Displays mode in command bar or quick bar.
seApplicationGlobalCurvatureCombDensity	Curvature Comb Density
seApplicationGlobalCurvatureCombMagnitude	Curvature Comb Magnitude
seApplicationGlobalCustomSettingFile	Custom Setting File
seApplicationGlobalDefaultSharpness	Default sharpness for new windows
seApplicationGlobalDisplayArcQuality	Display Arc Quality
seApplicationGlobalDisplayQuality	Display Quality
seApplicationGlobalDisplaySectionCaps	Enable the display of section caps with dynamic sections
seApplicationGlobalDisplayStatistics	Enable display timing statistics in the status bar
seApplicationGlobalDocumentNameFormula
seApplicationGlobalDynamicTransition	Dynamic view transition smoothness
seApplicationGlobalECORootFolder	ECO Root Folder
seApplicationGlobalECRRootFolder	ECR Root Folder
seApplicationGlobalEnableDynamicTolerance	Enable dynamic tolerancing of facet data
seApplicationGlobalEnableThreadedDisplay	Enable multithreaded displays
seApplicationGlobalHideAllComponents	Hide All Components
seApplicationGlobalHoleSizeFile	Hole Size File
seApplicationGlobalInReviewRootFolder	In Review Root Folder
seApplicationGlobalInsightCacheLocation	Set InsightCacheLocation
seApplicationGlobalInsightFolderMappingFileLocation	Set InsightFolderMappingFileLocation
seApplicationGlobalInWorkRootFolder	Obsolete Root Folder
seApplicationGlobalISOToleranceFile	ISO Tolerance File
seApplicationGlobalLogFilesLocation	Set LogFilesLocation
seApplicationGlobalLookAheadVersion	LookAheadVersion
seApplicationGlobalMakeRevisionsObsolete	Make Revisions Obsolete
seApplicationGlobalObsoleteRootFolder	Obsolete Root Folder
seApplicationGlobalOfflineMode	Set OfflineMode
seApplicationGlobalOnLineHelpLocation
seApplicationGlobalOpacityRefPlane	Opacity RefPlane
seApplicationGlobalOpenAsReadOnly3DFile
seApplicationGlobalOpenAsReadOnly3DFile_IndirectFiles
seApplicationGlobalOpenAsReadOnlyDftFile
seApplicationGlobalOpenAsReadOnlyDftFile_IndirectFiles
seApplicationGlobalOverlayColor	The color for visible edge overlay
seApplicationGlobalOverlayColorMode	The color mode for visible edge overlay [1=Absolute, 2=Relative]
seApplicationGlobalPackagedCollaborationRootFolder	Packaged Collaboration Root Folder
seApplicationGlobalPipeThreadfsFile	PipeThreadfsFile
seApplicationGlobalPrereleaseRootFolder	Prerelease Root Folder
seApplicationGlobalReleasedRootFolder	Released Root Folder
seApplicationGlobalRevisionDelimiter	Sets Revision Delimiter
seApplicationGlobalSaveMultiCADDatasettoTC
seApplicationGlobalSearchScope	Set SearchScope
seApplicationGlobalSectionCurvatureCombDensity
seApplicationGlobalSectionCurvatureCombMagnitude
seApplicationGlobalSessionDraftOpenInactive	Draft inactive mode on open (boolean)
seApplicationGlobalSheetTabDisplayInfo	Specifies what information is displayed in the sheet tab : 0 = sheet number; 1 = sheet name; 2 = sheet number and sheet name
seApplicationGlobalSheetTabDisplayInfoSeparator	Specifies the separator string used between the sheet number and sheet name when both are displayed in the sheet tabs.
seApplicationGlobalShowUnitsInValueFields	Shows units of measure in value fields.
seApplicationGlobalSoftwareVHL	Enable software VHL/Disable hardware VHL
seApplicationGlobalStatusBarCmdFinder	Status Bar Command Finder
seApplicationGlobalStatusBarCommonViews	Status Bar Common Views
seApplicationGlobalStatusBarFit	Status Bar Fit
seApplicationGlobalStatusBarLookAtFace	Status Bar Look At Face
seApplicationGlobalStatusBarNamedViews	Status Bar Named View
seApplicationGlobalStatusBarPan	Status Bar Pan
seApplicationGlobalStatusBarPreviousView	Status Bar Previous View
seApplicationGlobalStatusBarRecordVideo
seApplicationGlobalStatusBarRotateView	Status Bar Rotate View
seApplicationGlobalStatusBarSketchView	Status Bar Sketch View
seApplicationGlobalStatusBarSpinAbout	Status Bar Spin About
seApplicationGlobalStatusBarUploadToYouTube
seApplicationGlobalStatusBarViewStyles	Status Bar View Styles
seApplicationGlobalStatusBarZoom	Status Bar Zoom
seApplicationGlobalStatusBarZoomArea	Status Bar Zoom Area
seApplicationGlobalStatusBarZoomSlider	Status Bar Zoom Slider
seApplicationGlobalStatusBarZoomTool	Status Bar Zoom Tool
seApplicationGlobalSystemInfo	Retrieve system information [readonly]
seApplicationGlobalTeamcenterFormula
seApplicationGlobalTeamCenterMode	TeamCenter Mode
seApplicationGlobalTemplateRootFolder	Template Root Folder
seApplicationGlobalUpdateDraft	Update draft files also
seApplicationGlobalUploadOnClose	Upload On Close
seApplicationGlobalUseAllSimplifiedParts	Use All Simplified Parts
seApplicationGlobalUseAllSimplifiedSubAssemblies	Use All Simplified SubAssemblies
seApplicationGlobalUseDetailEnvelopeDisplayAsCircle	Show Detail Envelope as Circle when TRUE.
seApplicationGlobalUseDetailEnvelopeStandard	Use to set the Detail Envelope Standard Constants. Valid values are defined by enum DetailEnvelopeStandardConstants.
seApplicationGlobalUseDimensionStyleElementMapAngularCoordinateDim
seApplicationGlobalUseDimensionStyleElementMapAngularDim
seApplicationGlobalUseDimensionStyleElementMapBalloon
seApplicationGlobalUseDimensionStyleElementMapBHC
seApplicationGlobalUseDimensionStyleElementMapBlockLabels
seApplicationGlobalUseDimensionStyleElementMapCallouts
seApplicationGlobalUseDimensionStyleElementMapCenterline
seApplicationGlobalUseDimensionStyleElementMapCenterMark
seApplicationGlobalUseDimensionStyleElementMapChamferDim
seApplicationGlobalUseDimensionStyleElementMapCircularDiameterDim
seApplicationGlobalUseDimensionStyleElementMapConnectors
seApplicationGlobalUseDimensionStyleElementMapCoordinateDim
seApplicationGlobalUseDimensionStyleElementMapDatumFrames
seApplicationGlobalUseDimensionStyleElementMapDatumPoints
seApplicationGlobalUseDimensionStyleElementMapDatumTargets
seApplicationGlobalUseDimensionStyleElementMapEdgeCondition
seApplicationGlobalUseDimensionStyleElementMapFCF
seApplicationGlobalUseDimensionStyleElementMapLeaders
seApplicationGlobalUseDimensionStyleElementMapLinDim
seApplicationGlobalUseDimensionStyleElementMapRadialDiameterDim
seApplicationGlobalUseDimensionStyleElementMapRadialDim
seApplicationGlobalUseDimensionStyleElementMapSTSymbols
seApplicationGlobalUseDimensionStyleElementMapSymmetricDiameterDim
seApplicationGlobalUseDimensionStyleElementMapWeldSymbols
seApplicationGlobalUseDimensionStyleMapping	Use Dimension Style Mapping
seApplicationGlobalUseDrawingViewShowCroppingEdges	Show cropping edges when TRUE.
seApplicationGlobalUseDrawingViewShowEdgesHiddenTangentEdgesHiddenByOtherParts	Show tangent edges that are hidden by other parts when TRUE.
seApplicationGlobalUseDrawingViewShowEdgesHiddenTangentEdgesSelfHidden	Show the hidden tangent edges when TRUE.
seApplicationGlobalUseISOToleranceTable	Use ISO Tolerance Table when TRUE. Use ANSI Tolerance Table when FALSE.
seApplicationGlobalUseOnLineHelp
seApplicationGlobalUserType	User Type
seApplicationGlobalZebraFolderMapping	Set ZebraFolderMapping
seApplicationGlobalZebraFormula

Specifies the global parameter for which the setting is to be returned. Valid values are members of the ApplicationGlobalConstants for Application objects, AssemblyGlobalConstants for AssemblyDocument objects, PartGlobalConstants for PartDocument objects, SheetMetalGlobalConstants for SheetMetalDocument objects, or WeldmentGlobalConstants for WeldmentDocument objects.

Value

Returns the setting of the specified global parameter. The data type returned depends on the data being queried. For Application objects, the return data type is Long or Variant. For all other objects, the returned data type is Double.

Example

Example (VB.NET)

Imports System.IO
Imports System.Reflection
Imports System.Runtime.InteropServices

Module Example
    <STAThread()> _
    Sub Main()
        Dim objApplication As SolidEdgeFramework.Application = Nothing
        Dim objType As Type = Nothing
        Dim objFieldInfos() As System.Reflection.FieldInfo
        Dim objFieldInfo As System.Reflection.FieldInfo
        Dim objValue As Object = Nothing
        Dim constantValue As SolidEdgeFramework.ApplicationGlobalConstants

        Try
            OleMessageFilter.Register()

            ' Connect to Solid Edge
            objApplication = Marshal.GetActiveObject("SolidEdge.Application")

            ' Demonstrate getting specific global value.
            objApplication.GetGlobalParameter(SolidEdgeFramework.ApplicationGlobalConstants.seApplicationGlobalSystemInfo, objValue)

            '
            ' Now demonstrate getting all global values by dynamically enumerating the ApplicationGlobalConstants via .NET reflection.
            '

            ' Get ApplicationGlobalConstants type
            objType = GetType(SolidEdgeFramework.ApplicationGlobalConstants)

            ' Get all ApplicationGlobalConstants constants
            objFieldInfos = objType.GetFields(System.Reflection.BindingFlags.Static Or System.Reflection.BindingFlags.Public)

            ' Loop through all of the constants and demonstrate getting their values.
            For Each objFieldInfo In objFieldInfos
                objValue = Nothing
                If Not objFieldInfo.IsSpecialName Then
                    constantValue = objFieldInfo.GetRawConstantValue()

                    ' Wrap GetGlobalParameter() in a try\catch because it can throw an exception.
                    Try
                        ' Get global parameter for specified constant.
                        objApplication.GetGlobalParameter(constantValue, objValue)
                    Catch ex As Exception
                        objValue = ex.Message
                    End Try

                    If objValue Is Nothing Then
                        objValue = String.Empty
                    End If

                    ' Write out constant and value.
                    Console.WriteLine("{0} = {1}", constantValue, objValue)
                End If
            Next
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        Finally
            OleMessageFilter.Revoke()
        End Try
    End Sub
End Module