ActiveEnvironment Property

Description

Returns the environment that belongs to the current active window of the document.

Property type

Read-only property

Syntax

Visual Basic
Public Property ActiveEnvironment As String

Remarks

An environment is a collection of menu bars, toolbars, and keyboard accelerators defined for a specific workflow in an application.

Example

Example (VB.NET)
Example (C#)

Option Infer On

Imports System
Imports System.Runtime.InteropServices

Namespace Examples
    Friend Class Program
        <STAThread>
        Shared Sub Main(ByVal args() As String)
            Dim application As SolidEdgeFramework.Application = Nothing

            Try
                ' See "Handling 'Application is Busy' and 'Call was Rejected By Callee' errors" topic.
                OleMessageFilter.Register()

                ' Attempt to connect to a running instance of Solid Edge.
                application = DirectCast(Marshal.GetActiveObject("SolidEdge.Application"), SolidEdgeFramework.Application)

                ' Get the name of the active environment.
                Dim activeEnvironment = application.ActiveEnvironment

                Console.WriteLine("ActiveEnvironment = '{0}'", activeEnvironment)
            Catch ex As System.Exception
                Console.WriteLine(ex)
            Finally
                OleMessageFilter.Unregister()
            End Try
        End Sub
    End Class
End Namespace

using System;
using System.Runtime.InteropServices;

namespace Examples
{
    class Program
    {
        [STAThread]
        static void Main(string[] args)
        {
            SolidEdgeFramework.Application application = null;

            try
            {
                // See "Handling 'Application is Busy' and 'Call was Rejected By Callee' errors" topic.
                OleMessageFilter.Register();

                // Attempt to connect to a running instance of Solid Edge.
                application = (SolidEdgeFramework.Application)Marshal.GetActiveObject("SolidEdge.Application");

                // Get the name of the active environment.
                var activeEnvironment = application.ActiveEnvironment;

                Console.WriteLine("ActiveEnvironment = '{0}'", activeEnvironment);
            }
            catch (System.Exception ex)
            {
                Console.WriteLine(ex);
            }
            finally
            {
                OleMessageFilter.Unregister();
            }
        }
    }
}