Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
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 buttonStyle);
218 
219 
228  long getID (EwErrorCode* pErrorCode);
229 
230 
240  BSTR getCommand (EwErrorCode* errorCode);
241 
242 
252  EwErrorCode setCommand (BSTR strCommand);
253 
254 };
255 
256 
261 [
262  object,
263  uuid(779E10A8-9370-4F87-9EE7-FD051EF33DA7),
264  dual,
265  nonextensible,
266  pointer_default(unique)
267 ]
268 interface IEwRibbonGroupX : IDispatch
269 {
278  BSTR getCaption (EwErrorCode* errorCode);
279 
280 
281 
290  EwErrorCode setCaption (BSTR strCaption);
291 
292 
302  IEwRibbonControlX addControl (EwRibbonControlType eType, BSTR strCommand, EwErrorCode* errorCode);
303 
304 
305 
316  IEwRibbonControlX getControlAt (int iIndex, EwErrorCode* errorCode);
317 
318 
327  int getControlCount (EwErrorCode* errorCode);
328 
329 
339  EwErrorCode removeControl (int iIndex);
340 
341 
349  EwErrorCode removeAll ();
350 
351 
360  long getID (EwErrorCode* pErrorCode);
361 
362 };
363 
368 [
369  object,
370  uuid(16767327-DD46-4EA7-AD9A-0844E008A4B2),
371  dual,
372  nonextensible,
373  pointer_default(unique)
374 ]
375 interface IEwRibbonTabX : IDispatch
376 {
385  BSTR getCaption (EwErrorCode* errorCode);
386 
387 
388 
397  EwErrorCode setCaption (BSTR strCaption);
398 
399 
409  IEwRibbonGroupX addGroup (BSTR strCaption, EwErrorCode* errorCode);
410 
411 
423  IEwRibbonGroupX insertGroup (BSTR strCaption, int iIndex, EwErrorCode* errorCode);
424 
425 
436  IEwRibbonGroupX getGroupAt (int iIndex, EwErrorCode* errorCode);
437 
438 
447  int getGroupCount (EwErrorCode* errorCode);
448 
449 
450 
460  EwErrorCode removeGroup (int iIndex);
461 
462 
470  EwErrorCode removeAllGroup ();
471 
472 
481  VARIANT_BOOL isVisible (EwErrorCode* errorCode);
482 
483 
492  EwErrorCode setVisible (VARIANT_BOOL bVisible);
493 
494 
495 
504  VARIANT_BOOL isEnabled (EwErrorCode* errorCode);
505 
506 
516  EwErrorCode setEnabled (VARIANT_BOOL bEnabled);
517 
518 
527  long getID (EwErrorCode* pErrorCode);
528 
529 
538  EwErrorCode remove ();
539 
540 
541 };
542 
543 
548 [
549  object,
550  uuid(424CCD51-1FDC-4CC5-83C3-D9D42A8376D4),
551  dual,
552  nonextensible,
553  pointer_default(unique)
554 ]
555 interface IEwRibbonX : IDispatch
556 {
566  IEwRibbonTabX addTab (BSTR strCaption, EwErrorCode* errorCode);
567 
568 
579  IEwRibbonTabX insertTab (BSTR strCaption, int iIndex, EwErrorCode* errorCode);
580 
581 
582 
591  IEwRibbonTabX getSelectedTab (EwErrorCode* errorCode);
592 
593 
594 
604  EwErrorCode setSelectedTab (int iIndex);
605 
606 
617  IEwRibbonTabX getTabAt (int iIndex, EwErrorCode* errorCode);
618 
619 
628  int getTabCount (EwErrorCode* errorCode);
629 
630 
631 
641  EwErrorCode removeTab (int iIndex);
642 
643 };
644 
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.
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:218
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.
IEwRibbonX::getSelectedTab
IEwRibbonTabX getSelectedTab(EwErrorCode *errorCode)
Return an IEwRibbonTabX that encapsulate the selected Ribbon Tab.
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:269
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:181
IEwRibbonTabX
Use this interface to manage the Ribbon tabs.
Definition: EwApplicationRibbon.idl:376
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:202
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:556
IEwRibbonControlX::getID
long getID(EwErrorCode *pErrorCode)
Get the Id's of control.
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.
IEwRibbonGroupX::addControl
IEwRibbonControlX addControl(EwRibbonControlType eType, BSTR strCommand, EwErrorCode *errorCode)
Add a new control at the end of the ribbon group.
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.
IEwRibbonGroupX::getID
long getID(EwErrorCode *pErrorCode)
Get the Id's of group.
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::setStyle
EwErrorCode setStyle(EwRibbonButtonStyle buttonStyle)
Set the style of the control.
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
IEwRibbonTabX::getID
long getID(EwErrorCode *pErrorCode)
Get the Id's of Tab.
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::getStyle
EwRibbonButtonStyle getStyle(EwErrorCode *errorCode)
Get the control's style.
Generated on Tue Sep 1 2020 17:01:21 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) 2020 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