AGI UI PluginsSend comments on this topic.
AddCustomUserControlPage Method (IAgUiPluginConfigurationPageBuilder)
See Also
pPlugin
A plugin object
AsmPath
A full path to the assembly containing the .NET user control type that will be created and embedded into a custom property page.
UserControlClass
A full name of the user control that will be instantiated and embedded into a new custom property page.
Caption
A text displayed as custom property page title.
Windows





Windows & Linux

Description

Adds a custom configuration page using the given path to a .NET assembly and the name of the custom user control residing in the assembly.

Syntax

[Visual Basic .NET]
Public Sub AddCustomUserControlPage( _
    ByVal pPlugin As IAgUiPlugin, _
    ByVal AsmPath As String, _
    ByVal UserControlClass As String, _
    ByVal Caption As String _
)
[C#]
public void AddCustomUserControlPage(
    IAgUiPlugin pPlugin,
    string AsmPath,
    string UserControlClass,
    string Caption
);
[Managed C++]
public: void AddCustomUserControlPage(
    IAgUiPlugin ^ pPlugin,
    String __gc ^ AsmPath,
    String __gc ^ UserControlClass,
    String __gc ^ Caption
);
[Unmanaged C++]
public: HRESULT AddCustomUserControlPage(
    IAgUiPlugin * pPlugin,
    BSTR AsmPath,
    BSTR UserControlClass,
    BSTR Caption
);
[Java]
public void addCustomUserControlPage(
    IAgUiPlugin pPlugin,
    String AsmPath,
    String UserControlClass,
    String Caption
);

Parameters

pPlugin
A plugin object
AsmPath
A full path to the assembly containing the .NET user control type that will be created and embedded into a custom property page.
UserControlClass
A full name of the user control that will be instantiated and embedded into a new custom property page.
Caption
A text displayed as custom property page title.

Remarks

AddCustomUserControlPage allows .NET user controls to be embedded into a custom property page.

See Also

Example

Add a custom property page
// Add a custom property page to configure the UI plugin 
// using .NET user control-derived type.
//
// The type 'MyCustomPropertyPageControl' must be derived from
// System.Windows.Forms.UserControl and is assumed to reside
// in the same assembly as the plugin.  
void IAgUiPlugin.OnDisplayConfigurationPage(IAgUiPluginConfigurationPageBuilder ConfigurationPageBuilder)
{
    ConfigurationPageBuilder.AddCustomUserControlPage(
        this,
        this.GetType().Assembly.Location,
        typeof(MyCustomPropertyPageControl).FullName,
        "Custom Property Page");
}
© 2025 Analytical Graphics, Inc. All Rights Reserved.