 |
SOLIDWORKS Electrical API
2022.0.0
Electrical API
|
Go to the documentation of this file.
4 midl_pragma warning(disable:2111)
9 import "EnumDefinition.idl";
18 uuid(FEF554E8-F0B8-4397-850B-A6F63A921B0A),
21 pointer_default(unique)
212 uuid(30E4BDC2-FF3F-490A-BF15-52332FA7CFEF),
215 pointer_default(unique)
511 uuid(779E10A8-9370-4F87-9EE7-FD051EF33DA7),
514 pointer_default(unique)
678 uuid(16767327-DD46-4EA7-AD9A-0844E008A4B2),
681 pointer_default(unique)
868 uuid(da667cd1-2b49-4144-84b4-99c27502ee1a),
871 pointer_default(unique)
1030 uuid(424CCD51-1FDC-4CC5-83C3-D9D42A8376D4),
1033 pointer_default(unique)
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.