Hide Table of Contents
SOLIDWORKS Electrical API  2022.0.0
Electrical API
EwApplicationRibbon.idl
Go to the documentation of this file.
1 #pragma once
2 
3 #if (__midl >= 501)
4 midl_pragma warning(disable:2111) /* Disable warning MIDL2111 regarding identifier lengths exceeding 31 chars. */
5 #endif
6 
7 import "oaidl.idl";
8 import "ocidl.idl";
9 import "EnumDefinition.idl";
10 
11 
16 [
17  object,
18  uuid(FEF554E8-F0B8-4397-850B-A6F63A921B0A),
19  dual,
20  nonextensible,
21  pointer_default(unique)
22 ]
23 interface IEwRibbonComboBoxControlX : IDispatch
24 {
33 
34 
43  int getSelectedIndex (EwErrorCode* errorCode);
44 
45 
55 
56 
65  EwErrorCode addItemText (BSTR strItemText);
66 
67 
77  EwErrorCode addItemTextAt (int iIndex, BSTR strItemText);
78 
79 
90  int findText (int iIndexStart, BSTR strFindItemText, EwErrorCode* errorCode);
91 
92 
101  EwErrorCode deleteItemAt (int iIndex);
102 
103 
112  int getItemCount (EwErrorCode* errorCode);
113 
114 
123  BSTR getSelectedText (EwErrorCode* errorCode);
124 
125 
134  BSTR getEditText (EwErrorCode* errorCode);
135 
136 
145  EwErrorCode setEditText (BSTR strEditText);
146 
147 
156  BSTR getEditHintText (EwErrorCode* errorCode);
157 
158 
167  EwErrorCode setEditHintText (BSTR strHintText);
168 
169 
178  EwErrorCode enableAutoComplete (VARIANT_BOOL bAutoComplete);
179 
180 
190  ULONGLONG getItemData (int iIndex, EwErrorCode* pErrorCode);
191 
192 
202  EwErrorCode setItemData (int iIndex, ULONGLONG pItemData);
203 
204 };
205 
210 [
211  object,
212  uuid(30E4BDC2-FF3F-490A-BF15-52332FA7CFEF),
213  dual,
214  nonextensible,
215  pointer_default(unique)
216 ]
217 interface IEwRibbonControlX : IDispatch
218 {
227  BSTR getCaption (EwErrorCode* errorCode);
228 
229 
230 
239  EwErrorCode setCaption (BSTR strCaption);
240 
241 
250  BSTR getToolTip (EwErrorCode* errorCode);
251 
252 
253 
262  EwErrorCode setToolTip (BSTR strToolTip);
263 
264 
273  BSTR getDescription (EwErrorCode* errorCode);
274 
275 
276 
285  EwErrorCode setDescription (BSTR strDescription);
286 
287 
296  VARIANT_BOOL isVisible (EwErrorCode* errorCode);
297 
298 
307  EwErrorCode setVisible (VARIANT_BOOL bVisible);
308 
309 
318  VARIANT_BOOL isEnabled (EwErrorCode* errorCode);
319 
320 
330  EwErrorCode setEnabled (VARIANT_BOOL bEnabled);
331 
332 
341  VARIANT_BOOL isBeginGroup (EwErrorCode* errorCode);
342 
343 
352  EwErrorCode setBeginGroup (VARIANT_BOOL bBeginGroup);
353 
354 
363  BSTR getShortcutText (EwErrorCode* errorCode);
364 
365 
374  EwErrorCode setShortcutText (BSTR strShortcutText);
375 
376 
388  EwErrorCode setIconFromImage (BSTR strImageFilePath, EwRibbonButtonSize eRibbonButtonSize , COLORREF crMask);
389 
390 
400 
401 
412 
413 
422  long getID (EwErrorCode* errorCode);
423 
424 
434  BSTR getCommand (EwErrorCode* errorCode);
435 
436 
446  EwErrorCode setCommand (BSTR strCommand);
447 
448 
462  IEwRibbonControlX addControl (EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode* errorCode);
463 
464 
474  VARIANT_BOOL getCheck (EwErrorCode* pErrorCode);
475 
476 
486  EwErrorCode setCheck (VARIANT_BOOL bCheck);
487 
488 
500 
501 
502 };
503 
504 
509 [
510  object,
511  uuid(779E10A8-9370-4F87-9EE7-FD051EF33DA7),
512  dual,
513  nonextensible,
514  pointer_default(unique)
515 ]
516 interface IEwRibbonGroupX : IDispatch
517 {
526  BSTR getCaption (EwErrorCode* errorCode);
527 
528 
529 
538  EwErrorCode setCaption (BSTR strCaption);
539 
540 
552  IEwRibbonControlX addControl (EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode* errorCode);
553 
554 
555 
566  IEwRibbonControlX getControlAt (int iIndex, EwErrorCode* errorCode);
567 
568 
577  int getControlCount (EwErrorCode* errorCode);
578 
579 
590 
591 
600 
601 
610  long getID (EwErrorCode* errorCode);
611 
612 
613 
629  IEwRibbonControlX insertControl (int nPosition, EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode* errorCode);
630 
631 
644 
645 
657 
658 
668  int getIndex (EwErrorCode* errorCode);
669 
670 };
671 
676 [
677  object,
678  uuid(16767327-DD46-4EA7-AD9A-0844E008A4B2),
679  dual,
680  nonextensible,
681  pointer_default(unique)
682 ]
683 interface IEwRibbonTabX : IDispatch
684 {
693  BSTR getCaption (EwErrorCode* errorCode);
694 
695 
696 
705  EwErrorCode setCaption (BSTR strCaption);
706 
707 
717  IEwRibbonGroupX addGroup (BSTR strCaption, EwErrorCode* errorCode);
718 
719 
731  IEwRibbonGroupX insertGroup (BSTR strCaption, int iIndex, EwErrorCode* errorCode);
732 
733 
744  IEwRibbonGroupX getGroupAt (int iIndex, EwErrorCode* errorCode);
745 
746 
755  int getGroupCount (EwErrorCode* errorCode);
756 
757 
758 
768  EwErrorCode removeGroup (int iIndex);
769 
770 
779 
780 
789  VARIANT_BOOL isVisible (EwErrorCode* errorCode);
790 
791 
800  EwErrorCode setVisible (VARIANT_BOOL bVisible);
801 
802 
803 
812  VARIANT_BOOL isEnabled (EwErrorCode* errorCode);
813 
814 
824  EwErrorCode setEnabled (VARIANT_BOOL bEnabled);
825 
826 
835  long getID (EwErrorCode* errorCode);
836 
837 
846  EwErrorCode remove ();
847 
848 
858  int getIndex (EwErrorCode* errorCode);
859 
860 };
861 
866 [
867  object,
868  uuid(da667cd1-2b49-4144-84b4-99c27502ee1a),
869  dual,
870  nonextensible,
871  pointer_default(unique)
872 ]
873 interface IEwRibbonQuickAccessControlX : IDispatch
874 {
885  IEwRibbonControlX findControlByID (int iControlId, EwErrorCode* errorCode);
886 
887 
897 
898 
910  IEwRibbonControlX addControl (EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode* errorCode);
911 
912 
923  IEwRibbonControlX getControlAt (int iIndex, EwErrorCode* errorCode);
924 
925 
934  int getControlCount (EwErrorCode* errorCode);
935 
936 
947 
948 
957 
958 
973  IEwRibbonControlX insertControlAt (int iIndex, EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode* errorCode);
974 
975 
985  EwErrorCode removeControlByID (int iControlID);
986 
987 
996 
997 
1009 
1010 
1021 
1022 };
1023 
1028 [
1029  object,
1030  uuid(424CCD51-1FDC-4CC5-83C3-D9D42A8376D4),
1031  dual,
1032  nonextensible,
1033  pointer_default(unique)
1034 ]
1035 interface IEwRibbonX : IDispatch
1036 {
1046  IEwRibbonTabX addTab (BSTR strCaption, EwErrorCode* errorCode);
1047 
1048 
1059  IEwRibbonTabX insertTab (BSTR strCaption, int iIndex, EwErrorCode* errorCode);
1060 
1061 
1062 
1072 
1073 
1074 
1085 
1086 
1097  IEwRibbonTabX getTabAt (int iIndex, EwErrorCode* errorCode);
1098 
1099 
1108  int getTabCount (EwErrorCode* errorCode);
1109 
1110 
1111 
1121  EwErrorCode removeTab (int iIndex);
1122 
1123 
1136 
1137 
1149  IEwRibbonTabX findTabByID (int iID, EwErrorCode* errorCode);
1150 
1151 
1162 
1163 
1164 };
IEwRibbonGroupX getGroupAt(int iIndex, EwErrorCode *errorCode)
Return the specified group of the current tab.
IEwRibbonComboBoxControlX insertComboBoxControl(int nPosition, EwErrorCode *pErrorCode)
Insert the ComboBox Control in Quick Access Toolbar.
int getSelectedIndex(EwErrorCode *errorCode)
Get the index of the current selected item in the ComboBox.
EwErrorCode removeGroup(int iIndex)
Remove a group specified by the index.
EwErrorCode setDescription(BSTR strDescription)
Set a description for this control.
EwErrorCode setStyle(EwRibbonButtonStyle eRibbonButtonStyle)
Set the style of the control.
long getID(EwErrorCode *errorCode)
Get the Id's of Tab.
IEwRibbonControlX getControlAt(int iIndex, EwErrorCode *errorCode)
Return the specified control of the current group.
EwErrorCode setCommand(BSTR strCommand)
Set the name of the command associated with this ribbon control.
EwErrorCode setCheck(VARIANT_BOOL bCheck)
Check or uncheck the control.
IEwRibbonTabX insertTab(BSTR strCaption, int iIndex, EwErrorCode *errorCode)
Insert new tab for ribbon bar to specified position and return the IEwRibbonTabX inserted.
EwErrorCode addItemTextAt(int iIndex, BSTR strItemText)
Add text item to the ComboBox at a specific position or index.
int getIndex(EwErrorCode *errorCode)
Return the index of the group.
IEwRibbonTabX findTabByID(int iID, EwErrorCode *errorCode)
Return an IEwRibbonTabX object that has the ID passed as parameter.
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwRibbonComboBoxControlX addComboBoxControl(EwErrorCode *pErrorCode)
Add the ComboBox Control in the pop-up button ribbon control.
EwErrorCode removeContent()
Removes all items from the ComboBox.
BSTR getCaption(EwErrorCode *errorCode)
Return the caption of this control.
EwErrorCode enableAutoComplete(VARIANT_BOOL bAutoComplete)
Enables or disables auto completion.
int getGroupCount(EwErrorCode *errorCode)
Return the number of group in the current tab.
IEwRibbonQuickAccessControlX getQuickAccessControl(EwErrorCode *errorCode)
Return an IEwRibbonQuickAccessControlX object.
EwRibbonButtonSize
Ribbon bar button's styles.
Definition: EnumDefinition.idl:240
int getControlCount(EwErrorCode *errorCode)
Return the number of control in the current group.
EwErrorCode resetQuickAccessToolbar()
Resets default controls in Quick Access Toolbar.
EwErrorCode setEnabled(VARIANT_BOOL bEnabled)
Set whether the tab is enabled.
IEwRibbonControlX addControl(EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Add a new control at the end of Quick Access Toolbar.
IEwRibbonControlX getControlAt(int iIndex, EwErrorCode *errorCode)
Return the specified control of Quick Access Toolbar.
EwErrorCode setVisible(VARIANT_BOOL bVisible)
Hide or show the control.
EwErrorCode setCaption(BSTR strCaption)
Set a new caption for this ribbon group.
long getID(EwErrorCode *errorCode)
Get the Id's of group.
IEwRibbonTabX getSelectedTab(EwErrorCode *errorCode)
Return an IEwRibbonTabX that encapsulate the selected Ribbon Tab.
int getIndex(EwErrorCode *errorCode)
Return the index of the tab.
IEwRibbonControlX addControl(EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Add a new control at the end of the ribbon group.
EwErrorCode setSelectedIndex(int iIndex)
Set the index of the item to be selected in the ComboBox.
BSTR getEditHintText(EwErrorCode *errorCode)
Get grayed-out text displayed in the edit control that displayed a helpful description of what the co...
VARIANT_BOOL isEnabled(EwErrorCode *errorCode)
Determine if the tab is enabled.
EwErrorCode removeControl(int iIndex)
Remove a control specified by the index.
IEwRibbonTabX getTabAt(int iIndex, EwErrorCode *errorCode)
Return an IEwRibbonTabX that encapsulate the Ribbon Tab specified by index.
BSTR getShortcutText(EwErrorCode *errorCode)
Get the control's shortcut.
Use this interface to manage the Ribbon group.
Definition: EwApplicationRibbon.idl:517
Use this interface to manage the quick access control on Ribbon.
Definition: EwApplicationRibbon.idl:874
EwErrorCode setCaption(BSTR strCaption)
Set a new caption for this control.
EwErrorCode setCaption(BSTR strCaption)
Set a new caption for this tab.
EwErrorCode removeControlByID(int iControlID)
Remove a control specified by the ID in Quick Access Toolbar.
IEwRibbonComboBoxControlX insertComboBoxControl(int nPosition, EwErrorCode *pErrorCode)
Insert the ComboBox Control in the Ribbon Group.
ULONGLONG getItemData(int iIndex, EwErrorCode *pErrorCode)
Get the item data value associated with the specified combo box item.
EwRibbonControlType
Type of the control that can be used in a ribbon.
Definition: EnumDefinition.idl:203
Use this interface to manage the Ribbon tabs.
Definition: EwApplicationRibbon.idl:684
VARIANT getQuickAccessControlIDArray(EwErrorCode *errorCode)
Call this member to get array of control IDs in Quick Access Toolbar.
BSTR getDescription(EwErrorCode *errorCode)
Return the description of this control.
int getTabCount(EwErrorCode *errorCode)
Return the number of tab of this ribbon bar.
EwErrorCode setEditText(BSTR strEditText)
Set the edit text.
EwRibbonButtonStyle
Ribbon bar button's styles.
Definition: EnumDefinition.idl:224
EwErrorCode setIconFromImage(BSTR strImageFilePath, EwRibbonButtonSize eRibbonButtonSize, COLORREF crMask)
Add an icon from file.
IEwRibbonControlX insertControlAt(int iIndex, EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Insert a new control in Quick Access Toolbar.
EwErrorCode setToolTip(BSTR strToolTip)
Set a new ToolTip for this control.
Use this interface to manage the Ribbon Bar.
Definition: EwApplicationRibbon.idl:1036
EwErrorCode setVisible(VARIANT_BOOL bVisible)
Hide or show the tab.
EwErrorCode removeTab(int iIndex)
Remove a Ribbon Tab specified by the index.
EwErrorCode setBeginGroup(VARIANT_BOOL bBeginGroup)
Begin a new group using a separator.
VARIANT_BOOL isBeginGroup(EwErrorCode *errorCode)
Determine if the control is a separator.
BSTR getCaption(EwErrorCode *errorCode)
Return the caption of this tab.
VARIANT_BOOL isVisible(EwErrorCode *errorCode)
Determine if the tab is visible.
IEwRibbonControlX insertControl(int nPosition, EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Insert a new control to a pop-up button in a ribbon.
EwErrorCode removeAllGroup()
Remove all groups.
EwErrorCode setItemData(int iIndex, ULONGLONG pItemData)
Set the item data value associated with the specified combo box item.
EwErrorCode deleteItemAt(int iIndex)
Delete a text item from the ComboBox.
BSTR getSelectedText(EwErrorCode *errorCode)
Return the selected item text from the ComboBox.
int getItemCount(EwErrorCode *errorCode)
Return the number of items in this ComboBox.
IEwRibbonGroupX insertGroup(BSTR strCaption, int iIndex, EwErrorCode *errorCode)
Add a new group at the specified index of the ribbon tab.
EwRibbonMainTabType
Enum used to get main tabs of ribbon of the Application.
Definition: EnumDefinition.idl:333
EwErrorCode setSelectedTab(int iIndex)
Select a Ribbon Tab.
int getControlCount(EwErrorCode *errorCode)
Return the number of controls in Quick Access Toolbar.
IEwRibbonComboBoxControlX addComboBoxControl(EwErrorCode *pErrorCode)
Add the ComboBox Control in the Ribbon Group.
EwErrorCode setShortcutText(BSTR strShortcutText)
Set the shortcut string of the control.
EwErrorCode addItemText(BSTR strItemText)
Add text item to the ComboBox.
BSTR getCaption(EwErrorCode *errorCode)
Return the caption of this ribbon group.
EwErrorCode removeAll()
Remove all controls.
BSTR getEditText(EwErrorCode *errorCode)
Get the edit text.
IEwRibbonTabX addTab(BSTR strCaption, EwErrorCode *errorCode)
Return an IEwRibbonTabX added to the Ribbon Tab.
int findText(int iIndexStart, BSTR strFindItemText, EwErrorCode *errorCode)
Find a text item in the ComboBox.
IEwRibbonControlX addControl(EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Add a new control to a pop-up button.
EwErrorCode setEditHintText(BSTR strHintText)
Set grayed-out text displayed in the edit control that displayed a helpful description of what the co...
IEwRibbonComboBoxControlX addComboBoxControl(EwErrorCode *pErrorCode)
Add the ComboBox Control in Quick Access Toolbar.
IEwRibbonTabX findTabByEnum(EwRibbonMainTabType eRibbonMainTabType, EwErrorCode *errorCode)
Return an IEwRibbonTabX object find by the input EwRibbonMainTabType enumeration.
VARIANT_BOOL getCheck(EwErrorCode *pErrorCode)
Determine if the control is checked.
EwErrorCode removeAll()
Remove all controls from Quick Access Toolbar.
IEwRibbonControlX findControlByID(int iControlId, EwErrorCode *errorCode)
Call this member to find the specified control in Quick Access Toolbar.
VARIANT_BOOL isEnabled(EwErrorCode *errorCode)
Determine if the control is enabled.
Use this interface to manage the ComboBox control on Ribbon.
Definition: EwApplicationRibbon.idl:24
Use this interface to manage the control on Ribbon tab.
Definition: EwApplicationRibbon.idl:218
VARIANT_BOOL isVisible(EwErrorCode *errorCode)
Determine if the control is visible.
EwErrorCode removeControlAt(int iIndex)
Remove a control specified by the index in Quick Access Toolbar.
IEwRibbonGroupX addGroup(BSTR strCaption, EwErrorCode *errorCode)
Add a new group at the end of the ribbon tab.
BSTR getToolTip(EwErrorCode *errorCode)
Return the ToolTip of this control.
EwErrorCode setEnabled(VARIANT_BOOL bEnabled)
Set whether the control is enabled.
BSTR getCommand(EwErrorCode *errorCode)
Return the text of parameter strCommand used when calling EwRibbonGroupX::addControl.
long getID(EwErrorCode *errorCode)
Get the Id's of control.
EwRibbonButtonStyle getStyle(EwErrorCode *errorCode)
Get the control's style.


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/EwApplicationRibbon.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) 2022 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.