Hide Table of Contents
SOLIDWORKS Electrical API  2021.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(30E4BDC2-FF3F-490A-BF15-52332FA7CFEF),
19  dual,
20  nonextensible,
21  pointer_default(unique)
22 ]
23 interface IEwRibbonControlX : IDispatch
24 {
33  BSTR getCaption (EwErrorCode* errorCode);
34 
35 
36 
45  EwErrorCode setCaption (BSTR strCaption);
46 
47 
56  BSTR getToolTip (EwErrorCode* errorCode);
57 
58 
59 
68  EwErrorCode setToolTip (BSTR strToolTip);
69 
70 
79  BSTR getDescription (EwErrorCode* errorCode);
80 
81 
82 
91  EwErrorCode setDescription (BSTR strDescription);
92 
93 
102  VARIANT_BOOL isVisible (EwErrorCode* errorCode);
103 
104 
113  EwErrorCode setVisible (VARIANT_BOOL bVisible);
114 
115 
124  VARIANT_BOOL isEnabled (EwErrorCode* errorCode);
125 
126 
136  EwErrorCode setEnabled (VARIANT_BOOL bEnabled);
137 
138 
147  VARIANT_BOOL isBeginGroup (EwErrorCode* errorCode);
148 
149 
158  EwErrorCode setBeginGroup (VARIANT_BOOL bBeginGroup);
159 
160 
169  BSTR getShortcutText (EwErrorCode* errorCode);
170 
171 
180  EwErrorCode setShortcutText (BSTR strShortcutText);
181 
182 
194  EwErrorCode setIconFromImage (BSTR strImageFilePath, EwRibbonButtonSize eRibbonButtonSize , COLORREF crMask);
195 
196 
205  EwRibbonButtonStyle getStyle (EwErrorCode* errorCode);
206 
207 
217  EwErrorCode setStyle (EwRibbonButtonStyle eRibbonButtonStyle);
218 
219 
228  long getID (EwErrorCode* errorCode);
229 
230 
240  BSTR getCommand (EwErrorCode* errorCode);
241 
242 
252  EwErrorCode setCommand (BSTR strCommand);
253 
254 
267  IEwRibbonControlX addControl (EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode* errorCode);
268 
269 };
270 
271 
276 [
277  object,
278  uuid(779E10A8-9370-4F87-9EE7-FD051EF33DA7),
279  dual,
280  nonextensible,
281  pointer_default(unique)
282 ]
283 interface IEwRibbonGroupX : IDispatch
284 {
293  BSTR getCaption (EwErrorCode* errorCode);
294 
295 
296 
305  EwErrorCode setCaption (BSTR strCaption);
306 
307 
318  IEwRibbonControlX addControl (EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode* errorCode);
319 
320 
321 
332  IEwRibbonControlX getControlAt (int iIndex, EwErrorCode* errorCode);
333 
334 
343  int getControlCount (EwErrorCode* errorCode);
344 
345 
355  EwErrorCode removeControl (int iIndex);
356 
357 
365  EwErrorCode removeAll ();
366 
367 
376  long getID (EwErrorCode* errorCode);
377 
378 };
379 
384 [
385  object,
386  uuid(16767327-DD46-4EA7-AD9A-0844E008A4B2),
387  dual,
388  nonextensible,
389  pointer_default(unique)
390 ]
391 interface IEwRibbonTabX : IDispatch
392 {
401  BSTR getCaption (EwErrorCode* errorCode);
402 
403 
404 
413  EwErrorCode setCaption (BSTR strCaption);
414 
415 
425  IEwRibbonGroupX addGroup (BSTR strCaption, EwErrorCode* errorCode);
426 
427 
439  IEwRibbonGroupX insertGroup (BSTR strCaption, int iIndex, EwErrorCode* errorCode);
440 
441 
452  IEwRibbonGroupX getGroupAt (int iIndex, EwErrorCode* errorCode);
453 
454 
463  int getGroupCount (EwErrorCode* errorCode);
464 
465 
466 
476  EwErrorCode removeGroup (int iIndex);
477 
478 
486  EwErrorCode removeAllGroup ();
487 
488 
497  VARIANT_BOOL isVisible (EwErrorCode* errorCode);
498 
499 
508  EwErrorCode setVisible (VARIANT_BOOL bVisible);
509 
510 
511 
520  VARIANT_BOOL isEnabled (EwErrorCode* errorCode);
521 
522 
532  EwErrorCode setEnabled (VARIANT_BOOL bEnabled);
533 
534 
543  long getID (EwErrorCode* errorCode);
544 
545 
554  EwErrorCode remove ();
555 
556 
557 };
558 
559 
564 [
565  object,
566  uuid(424CCD51-1FDC-4CC5-83C3-D9D42A8376D4),
567  dual,
568  nonextensible,
569  pointer_default(unique)
570 ]
571 interface IEwRibbonX : IDispatch
572 {
582  IEwRibbonTabX addTab (BSTR strCaption, EwErrorCode* errorCode);
583 
584 
595  IEwRibbonTabX insertTab (BSTR strCaption, int iIndex, EwErrorCode* errorCode);
596 
597 
598 
607  IEwRibbonTabX getSelectedTab (EwErrorCode* errorCode);
608 
609 
610 
620  EwErrorCode setSelectedTab (int iIndex);
621 
622 
633  IEwRibbonTabX getTabAt (int iIndex, EwErrorCode* errorCode);
634 
635 
644  int getTabCount (EwErrorCode* errorCode);
645 
646 
647 
657  EwErrorCode removeTab (int iIndex);
658 
659 };
IEwRibbonTabX::getGroupAt
IEwRibbonGroupX getGroupAt(int iIndex, EwErrorCode *errorCode)
Return the specified group of the current tab.
IEwRibbonTabX::removeGroup
EwErrorCode removeGroup(int iIndex)
Remove a group specified by the index.
IEwRibbonControlX::setDescription
EwErrorCode setDescription(BSTR strDescription)
Set a description for this control.
IEwRibbonControlX::setStyle
EwErrorCode setStyle(EwRibbonButtonStyle eRibbonButtonStyle)
Set the style of the control.
IEwRibbonTabX::getID
long getID(EwErrorCode *errorCode)
Get the Id's of Tab.
IEwRibbonGroupX::getControlAt
IEwRibbonControlX getControlAt(int iIndex, EwErrorCode *errorCode)
Return the specified control of the current group.
IEwRibbonControlX::setCommand
EwErrorCode setCommand(BSTR strCommand)
Set the name of the command associated with this ribbon control.
IEwRibbonX::insertTab
IEwRibbonTabX insertTab(BSTR strCaption, int iIndex, EwErrorCode *errorCode)
Insert new tab for ribbon bar to specified position and return the IEwRibbonTabX inserted.
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwRibbonControlX::getCaption
BSTR getCaption(EwErrorCode *errorCode)
Return the caption of this control.
IEwRibbonTabX::getGroupCount
int getGroupCount(EwErrorCode *errorCode)
Return the number of group in the current tab.
EwRibbonButtonSize
EwRibbonButtonSize
Ribbon bar button's styles.
Definition: EnumDefinition.idl:220
IEwRibbonGroupX::getControlCount
int getControlCount(EwErrorCode *errorCode)
Return the number of control in the current group.
IEwRibbonTabX::setEnabled
EwErrorCode setEnabled(VARIANT_BOOL bEnabled)
Set whether the tab is enabled.
IEwRibbonControlX::setVisible
EwErrorCode setVisible(VARIANT_BOOL bVisible)
Hide or show the control.
IEwRibbonGroupX::setCaption
EwErrorCode setCaption(BSTR strCaption)
Set a new caption for this ribbon group.
IEwRibbonGroupX::getID
long getID(EwErrorCode *errorCode)
Get the Id's of group.
IEwRibbonX::getSelectedTab
IEwRibbonTabX getSelectedTab(EwErrorCode *errorCode)
Return an IEwRibbonTabX that encapsulate the selected Ribbon Tab.
IEwRibbonGroupX::addControl
IEwRibbonControlX addControl(EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Add a new control at the end of the ribbon group.
IEwRibbonTabX::isEnabled
VARIANT_BOOL isEnabled(EwErrorCode *errorCode)
Determine if the tab is enabled.
IEwRibbonGroupX::removeControl
EwErrorCode removeControl(int iIndex)
Remove a control specified by the index.
IEwRibbonX::getTabAt
IEwRibbonTabX getTabAt(int iIndex, EwErrorCode *errorCode)
Return an IEwRibbonTabX that encapsulate the Ribbon Tab specified by index.
IEwRibbonControlX::getShortcutText
BSTR getShortcutText(EwErrorCode *errorCode)
Get the control's shortcut.
IEwRibbonGroupX
Use this interface to manage the Ribbon group.
Definition: EwApplicationRibbon.idl:284
IEwRibbonControlX::setCaption
EwErrorCode setCaption(BSTR strCaption)
Set a new caption for this control.
IEwRibbonTabX::setCaption
EwErrorCode setCaption(BSTR strCaption)
Set a new caption for this tab.
EwRibbonControlType
EwRibbonControlType
Type of the control that can be used in a ribbon.
Definition: EnumDefinition.idl:183
IEwRibbonTabX
Use this interface to manage the Ribbon tabs.
Definition: EwApplicationRibbon.idl:392
IEwRibbonControlX::getDescription
BSTR getDescription(EwErrorCode *errorCode)
Return the description of this control.
IEwRibbonX::getTabCount
int getTabCount(EwErrorCode *errorCode)
Return the number of tab of this ribbon bar.
EwRibbonButtonStyle
EwRibbonButtonStyle
Ribbon bar button's styles.
Definition: EnumDefinition.idl:204
IEwRibbonControlX::setIconFromImage
EwErrorCode setIconFromImage(BSTR strImageFilePath, EwRibbonButtonSize eRibbonButtonSize, COLORREF crMask)
Add an icon from file.
IEwRibbonControlX::setToolTip
EwErrorCode setToolTip(BSTR strToolTip)
Set a new ToolTip for this control.
IEwRibbonX
Use this interface to manage the Ribbon Bar.
Definition: EwApplicationRibbon.idl:572
IEwRibbonTabX::setVisible
EwErrorCode setVisible(VARIANT_BOOL bVisible)
Hide or show the tab.
IEwRibbonX::removeTab
EwErrorCode removeTab(int iIndex)
Remove a Ribbon Tab specified by the index.
IEwRibbonControlX::setBeginGroup
EwErrorCode setBeginGroup(VARIANT_BOOL bBeginGroup)
Begin a new group using a separator.
IEwRibbonControlX::isBeginGroup
VARIANT_BOOL isBeginGroup(EwErrorCode *errorCode)
Determine if the control is a separator.
IEwRibbonTabX::getCaption
BSTR getCaption(EwErrorCode *errorCode)
Return the caption of this tab.
IEwRibbonTabX::isVisible
VARIANT_BOOL isVisible(EwErrorCode *errorCode)
Determine if the tab is visible.
IEwRibbonTabX::removeAllGroup
EwErrorCode removeAllGroup()
Remove all groups.
IEwRibbonTabX::insertGroup
IEwRibbonGroupX insertGroup(BSTR strCaption, int iIndex, EwErrorCode *errorCode)
Add a new group at the specified index of the ribbon tab.
IEwRibbonX::setSelectedTab
EwErrorCode setSelectedTab(int iIndex)
Select a Ribbon Tab.
IEwRibbonControlX::setShortcutText
EwErrorCode setShortcutText(BSTR strShortcutText)
Set the shortcut string of the control.
IEwRibbonGroupX::getCaption
BSTR getCaption(EwErrorCode *errorCode)
Return the caption of this ribbon group.
IEwRibbonGroupX::removeAll
EwErrorCode removeAll()
Remove all controls.
IEwRibbonX::addTab
IEwRibbonTabX addTab(BSTR strCaption, EwErrorCode *errorCode)
Return an IEwRibbonTabX added to the Ribbon Tab.
IEwRibbonControlX::addControl
IEwRibbonControlX addControl(EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
Add a new control to a pop-up button.
IEwRibbonControlX::isEnabled
VARIANT_BOOL isEnabled(EwErrorCode *errorCode)
Determine if the control is enabled.
IEwRibbonControlX
Use this interface to manage the control on Ribbon tab.
Definition: EwApplicationRibbon.idl:24
IEwRibbonControlX::isVisible
VARIANT_BOOL isVisible(EwErrorCode *errorCode)
Determine if the control is visible.
IEwRibbonTabX::addGroup
IEwRibbonGroupX addGroup(BSTR strCaption, EwErrorCode *errorCode)
Add a new group at the end of the ribbon tab.
IEwRibbonControlX::getToolTip
BSTR getToolTip(EwErrorCode *errorCode)
Return the ToolTip of this control.
IEwRibbonControlX::setEnabled
EwErrorCode setEnabled(VARIANT_BOOL bEnabled)
Set whether the control is enabled.
IEwRibbonControlX::getCommand
BSTR getCommand(EwErrorCode *errorCode)
Return the text of parameter strCommand used when calling EwRibbonGroupX::addControl.
IEwRibbonControlX::getID
long getID(EwErrorCode *errorCode)
Get the Id's of control.
IEwRibbonControlX::getStyle
EwRibbonButtonStyle getStyle(EwErrorCode *errorCode)
Get the control's style.
Generated on Thu Aug 20 2020 08:40:14 for SOLIDWORKS Electrical API by   doxygen 1.8.18


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) 2021 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.

0.20.46