QuickOPC User's Guide and Reference
EasyUAFormsApplication Class Members
Properties  Methods  Events


OpcLabs.EasyOpcForms Assembly > OpcLabs.EasyOpc.UA.Forms.Application Namespace : EasyUAFormsApplication Class

The following tables list the members exposed by EasyUAFormsApplication.

Public Constructors
 NameDescription
Public ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyA dictionary containing the application ID for each GDS endpoint the application is registered with, as known to the application. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public PropertyContains parameters that define the OPC UA application and its behavior. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public PropertyThe PKI store group used by the OPC UA application. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public PropertyThe certificate generation parameters used by the application if no other parameters are specified. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public PropertyThe certificate generation parameters used by the application if no other parameters are specified. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public Property (Inherited from System.ComponentModel.Component)
Public PropertyCan be used to distinguish otherwise equal widgets. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public Propertystatic (Shared in Visual Basic)An instance of the OPC-UA Windows Forms application class.  
Public PropertyDetermines whether shared data made available by this component (such as OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore.ApplicationParameters) will be serialized. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public Property (Inherited from System.ComponentModel.Component)
Public PropertyDetermines whether GDS and CM operations are supported. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Top
Protected Properties
 NameDescription
Protected Property (Inherited from System.ComponentModel.Component)
Protected Property (Inherited from System.ComponentModel.Component)
Protected Property (Inherited from System.ComponentModel.Component)
Protected PropertyInfrastructure. Infrastructure. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplication)
Protected PropertyThe service container provided by this widget to inheritors. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Public Methods
 NameDescription
Public MethodOverloaded. Adds items related to OPC UA application to the system menu of the given form.

The method adds the "Administer OPC UA Application" command to the system menu of the form, allowing the user to view and manage the certificate trust, and the own application certificate.

 
Public MethodAssures presence and validity of the own certificate the application is currently configured to use. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodBegins an asynchronous operation that obtains a new application own certificate from the certificate manager, and stores it for subsequent usage. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodCancels an asynchronous operation started with the OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.BeginObtainNewCertificate method. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodOverridden.   
Public MethodCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodCreates the own certificate the application is currently configured to use. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodOverloaded.  (Inherited from System.ComponentModel.Component)
Public MethodHandles the end of the asynchronous operation started by the OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.BeginObtainNewCertificate method. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public Method (Inherited from object)
Public MethodExports the OPC UA application configuration data into an XML stream. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodExports the own certificate and optionally its private key to a given file. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodExports the registration data of the OPC UA application into an XML stream. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodExports the security settings of the OPC UA application into an XML stream. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodFinds all registrations for this application URI in the GDS. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodFinds the own certificate the application is currently configured to use. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodGets the subject distinguished name the application is configured to use for its certificates. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodGets the effective OPC UA application manifest, i.e. the currently used application registration information together with data related to PKI administration, such as paths to the certificate stores used. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodServes as the default hash function. (Inherited from object)
Public MethodRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public Method (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodDetermines strength of the password that is configured for use with the given certificate. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodGets the System.Type of the current instance. (Inherited from object)
Public MethodImports the own certificate and its private key from a given file. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodFinds all application certificate sub-ids. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodRetrieves certificate type elements for the certificate types available for a given application store kind. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodProtects or unprotects the private key of the given certificate. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodRetrieves the current trust lists for the application from the certificate manager, and refreshes own certificate stores accordingly. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodCreates an application registration in the GDS, assigning it a new application ID. Existing registrations with the same application URI are removed first. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodRemoves the own certificates the application is currently configured to use. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodRemoves the password used to access the private key for given certificate. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodSets the password used to access the private key for given certificate. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodReturns a string that represents the current object. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public MethodRemoves an application registration from the GDS, if it exists. All existing registrations for the application URI are removed. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodUpdates an application registration in the GDS, keeping its application ID. A new registration is created if the application is not yet registered in the GDS. Preexisting registrations with the same application URI are removed. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodValidates the own certificate the application is currently configured to use. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Public MethodOverloaded. Defines a generalized method that classes must implement to create type-specific method for determining value equality of instances. Determines whether this instance has the same value as a given other instance. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Public Method (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Protected Methods
 NameDescription
Protected Method (Inherited from System.ComponentModel.Component)
Protected MethodOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Protected MethodInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Protected MethodInfrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget)
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded. Assures presence of the own certificate the application is currently configured to use.Returns true if a new certificate has been created. Returns false if an existing certificate was found and accepted as the current own certificate.

If the own certificate does not exist in the certificate store prior to the operation, the method creates it. Otherwise, the method also checks whether the instance certificate is present in the trusted peers certificate store, and if it is absent, it copies it there. This is in contrast to the OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.CreateOwnCertificate method, which always creates a new certificate when successful.

.NET

Public Extension MethodOverloaded. Begins an asynchronous operation that obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.
Public Extension MethodOverloaded. Creates the own certificate the application is currently configured to use.
Public Extension MethodExports the OPC UA application configuration data into an XML file.
Public Extension MethodExports the OPC UA application manifest into a stream.
Public Extension MethodExports the OPC UA application manifest into an XML file.
Public Extension MethodOverloaded. Exports the own certificate and optionally its private key to a given file.
Public Extension MethodExports the registration data of the OPC UA application into an XML file.
Public Extension MethodExports the security settings of the OPC UA application into an XML file.
Public Extension MethodFinds the own certificate the application is currently configured to use.
Public Extension MethodGets the OPC UA registration information for this application.
Public Extension MethodGets an application ID assigned to the application by a specified GDS.
Public Extension MethodGets the subject distinguished name the application is configured to use for its certificates.
Public Extension MethodGets a dictionary of certificate subject names corresponding to all application certificate sub-ids.
Public Extension MethodDetermines strength of the password that is configured for use with the default certificate.
Public Extension MethodOverloaded. Determines whether the application's own certificate is present.Returns true if the application's own certificate is present in the certificate store. Returns false otherwise.
Public Extension MethodOverloaded. Determines whether a non-empty password is in use for the default certificate.
Public Extension MethodImports the own default certificate and its private key from a given file.
Public Extension MethodRetrieves certificate type elements available for an application instance.
Public Extension MethodOverloaded. Obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.Returns the certificate obtained from the certificate manager.

The operation is synchronous. It can take considerable time to execute, because it involves multiple steps, and waiting for a finalization of the request by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method).

For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.BeginObtainNewCertificate method and related extension methods.

For a task-based asynchronous programming pattern alternative, see the ObtainNewCertificateAsync(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.

Public Extension MethodOverloaded. Asynchronously obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.Returns a task that represents the asynchronous operation. The value of the TResult contains the certificate obtained from the certificate manager.

The operation is asynchronous, because it involves multiple steps, and waiting for a finalization of the request by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method).

For a synchronous alternative, see the ObtainNewCertificate(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.

For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.BeginObtainNewCertificate method and related extension methods.

Public Extension MethodProtects or unprotects the private key of the default certificate.
Public Extension MethodOverloaded. Protects the private key of the default certificate.
Public Extension MethodRetrieves the current trust lists for the application from the certificate manager, and refreshes own certificate stores accordingly.
Public Extension MethodOverloaded. Removes the own default certificate the application is currently configured to use.
Public Extension MethodSets the password used to access the private key for the default certificate.
Public Extension MethodShows the form which allows the interactive user to administer the OPC UA application modally.
Public Extension MethodOverloaded. Unprotects the private key of the default certificate.
Public Extension MethodOverloaded. Validates the own certificate the application is currently configured to use.

The own certificate must exist in the certificate store prior to the operation, otherwise an error is reported.

Top
Public Events
 NameDescription
Public Event (Inherited from System.ComponentModel.Component)
Public EventRaised when the private key configured for the use with the own certificate has changed. (Inherited from OpcLabs.EasyOpc.UA.Application.EasyUAApplicationCore)
Top
See Also

Reference

EasyUAFormsApplication Class
OpcLabs.EasyOpc.UA.Forms.Application Namespace