Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
EwApplicationCaptionBarObjects.idl
Go to the documentation of this file.
1import "EnumDefinition.idl";
2
3
4
9[
10 object,
11 uuid(F289A71A-5940-4D96-B6B2-5F68C8839A0F),
12 dual,
13 nonextensible,
14 pointer_default(unique)
15]
16interface IEwCaptionBarControlX : IDispatch
17{
26 BSTR getCaption (EwErrorCode* errorCode);
27
28
29
38 EwErrorCode setCaption (BSTR strCaption);
39
40
49 BSTR getToolTip (EwErrorCode* errorCode);
50
51
52
61 EwErrorCode setToolTip (BSTR strToolTip);
62
73 EwErrorCode setIconFromImage (BSTR strImageFilePath, COLORREF crMask);
74
75
85
86
96 EwErrorCode setStyle (EwCaptionBarPushButtonStyle eCaptionBarPushButtonStyle);
97
98
108 VARIANT_BOOL isVisible (EwErrorCode* errorCode);
109
110
120 EwErrorCode setVisible (VARIANT_BOOL bVisible);
121
122
132 VARIANT_BOOL isEnabled (EwErrorCode* errorCode);
133
134
145 EwErrorCode setEnabled (VARIANT_BOOL bEnabled);
146
147
153 int getID ();
154
155
165 BSTR getCommand (EwErrorCode* errorCode);
166
167
177 EwErrorCode setCommand (BSTR strCommand);
178
179};
180
181
182
183
188[
189 object,
190 uuid(D3B63584-3D01-43D7-AAED-F33610CCDEF2),
191 dual,
192 nonextensible,
193 pointer_default(unique)
194]
195interface IEwCaptionBarX : IDispatch
196{
206 IEwCaptionBarControlX addControl (BSTR strCommand, EwErrorCode* errorCode);
207
208
217
218
228
229
243
244
258
259
272
273
286
287
298
299};
EwCaptionBarPushButtonStyle
Caption bar button's styles.
Definition: EnumDefinition.idl:398
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
Use this interface to manage the control on captionbar.
Definition: EwApplicationCaptionBarObjects.idl:17
VARIANT_BOOL isEnabled(EwErrorCode *errorCode)
Determine if the control is enabled.
EwErrorCode setIconFromImage(BSTR strImageFilePath, COLORREF crMask)
Add an icon from file.
EwErrorCode setVisible(VARIANT_BOOL bVisible)
Hide or show the control.
BSTR getToolTip(EwErrorCode *errorCode)
Return the ToolTip of this control.
BSTR getCaption(EwErrorCode *errorCode)
Return the caption of this control.
EwErrorCode setStyle(EwCaptionBarPushButtonStyle eCaptionBarPushButtonStyle)
Set the style of the control.
VARIANT_BOOL isVisible(EwErrorCode *errorCode)
Determine if the control is visible.
int getID()
Get the ID of the control.
EwCaptionBarPushButtonStyle getStyle(EwErrorCode *errorCode)
Get the control's style.
EwErrorCode setEnabled(VARIANT_BOOL bEnabled)
Set whether the control is enabled.
EwErrorCode setCaption(BSTR strCaption)
Set a new caption for this control.
BSTR getCommand(EwErrorCode *errorCode)
Return the text of parameter strCommand used when adding a control to the CaptionBar.
EwErrorCode setCommand(BSTR strCommand)
Set the name of the command associated with this control of the CaptionBar.
EwErrorCode setToolTip(BSTR strToolTip)
Set a new ToolTip for this control.
Use this interface to manage the caption Bar.
Definition: EwApplicationCaptionBarObjects.idl:196
IEwCaptionBarControlX findControlByID(int iControlId, EwErrorCode *errorCode)
Get CaptionBar control from ID.
EwErrorCode removeControlByCommandName(BSTR strCommandName)
Remove CaptionBar control from command name.
IEwCaptionBarControlX findControlByCommandName(BSTR strCommandName, EwErrorCode *errorCode)
Get CaptionBar control from command name.
EwErrorCode removeAll()
Remove all controls from Caption Bar.
EwErrorCode recalcLayout()
Recalculate Layout of caption bar for instance if button is hidden, or text length changed.
VARIANT getCaptionBarControlIDArray(EwErrorCode *errorCode)
Get array of control IDs in CaptionBar.
EwErrorCode removeControlByID(int iID)
Remove CaptionBar control from ID.
IEwCaptionBarControlX addControl(BSTR strCommand, EwErrorCode *errorCode)
Return an IEwCaptionBarControlX added to the Captionbar.


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:   SOLIDWORKS Electrical API: idl_converted/EwApplicationCaptionBarObjects.idl Source File
*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) 2024 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.