Hide Table of Contents
AddControl2 Method (IPropertyManagerPage2)

Adds a control to this PropertyManager page.

.NET Syntax

Visual Basic (Declaration) 
Function AddControl2( _
   ByVal ID As System.Integer, _
   ByVal ControlType As System.Short, _
   ByVal Caption As System.String, _
   ByVal LeftAlign As System.Short, _
   ByVal Options As System.Integer, _
   ByVal Tip As System.String _
) As System.Object
Visual Basic (Usage) 
Dim instance As IPropertyManagerPage2
Dim ID As System.Integer
Dim ControlType As System.Short
Dim Caption As System.String
Dim LeftAlign As System.Short
Dim Options As System.Integer
Dim Tip As System.String
Dim value As System.Object
 
value = instance.AddControl2(ID, ControlType, Caption, LeftAlign, Options, Tip)
C# 
System.object AddControl2( 
   System.int ID,
   System.short ControlType,
   System.string Caption,
   System.short LeftAlign,
   System.int Options,
   System.string Tip
)
C++/CLI 
System.Object^ AddControl2( 
&   System.int ID,
&   System.short ControlType,
&   System.String^ Caption,
&   System.short LeftAlign,
&   System.int Options,
&   System.String^ Tip
) 

Parameters

ID
Resource ID of this control whose value is passed back to the add-in through the IPropertyManagerPage2Handler9 interface
ControlType
Type of control as defined in swPropertyManagerPageControlType_e
Caption
Caption of this control
LeftAlign
Left alignment of this control as defined in swPropertyManagerPageControlLeftAlign_e
Options
Options as defined in swAddControlOptions_e (see Remarks)
Tip
ToolTip for this control

Return Value

Newly created PropertyManager page control

Example

See the IPropertyManagerPage2 examples.

Remarks

You can only use this method to set properties on the PropertyManager before the page is displayed or while it is closed. See IPropertyManagerPage2::Show2 and IPropertyManagerPage2::Close.

 

To follow the SOLIDWORKS standards when designing a new PropertyManager page, it is a good idea to use IPropertyManagerPage2::AddGroupBox or IPropertyManagerPage2::IAddGroupBox and IPropertyManagerPageGroup::AddControl2 to add controls for the page inside group boxes.

 

When you specify swAddControlOptions_e.swControlOptions_SmallGapAbove for the Options parameter, the gap created between the new control and the previous control is smaller than a typical gap. Also, the control is hidden unless you specify swAddControlOptions_e.swControlOptions_Visible for the Options parameter. In the previous versions of this method, IPropertyManagerPage2::AddControl and IPropertyManagerPage2::IAddControl, the control was visible regardless if the Options parameter was set or not set to swAddControlOptions_e.swControlOptions_Visible.

 

See Also

Availability

SOLIDWORKS 2014 SP1, Revision Number 22.1


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   AddControl2 Method (IPropertyManagerPage2)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:



x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2015 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.