Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Add a Custom CommandAdd a Custom Command
Expand Add an Add-inAdd an Add-in
Expand Release NotesRelease Notes
Expand C# SamplesC# Samples
Expand List of SWE commandsList of SWE commands
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
Collapse IDispatchIDispatch
IEwAPIX
IEwAddIn
IEwAddinInternalX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCaptionBarControlX
IEwCaptionBarX
IEwClassificationManagerX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwDocumentManagerX
IEwDocumentX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Expand IEwObjectDispatchXIEwObjectDispatchX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectMultilingualTextFontX
IEwProjectMultilingualTextManagerX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSelectorDialogX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand PDM Pro API Web ServicePDM Pro API Web Service
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Inspection API HelpSOLIDWORKS Inspection API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API 2023.0.0
Electrical API
Public Member Functions | List of all members
IEwRibbonQuickAccessControlX Interface Reference

Use this interface to manage the quick access control on Ribbon. More...

Inheritance diagram for IEwRibbonQuickAccessControlX:
Inheritance graph
[legend]

Public Member Functions

IEwRibbonControlX findControlByID (int iControlId, EwErrorCode *errorCode)
 Call this member to find the specified control in Quick Access Toolbar. More...
 
VARIANT getQuickAccessControlIDArray (EwErrorCode *errorCode)
 Call this member to get array of control IDs in Quick Access Toolbar. More...
 
IEwRibbonControlX addControl (EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
 Add a new control at the end of Quick Access Toolbar. More...
 
IEwRibbonControlX getControlAt (int iIndex, EwErrorCode *errorCode)
 Return the specified control of Quick Access Toolbar. More...
 
int getControlCount (EwErrorCode *errorCode)
 Return the number of controls in Quick Access Toolbar. More...
 
EwErrorCode removeControlAt (int iIndex)
 Remove a control specified by the index in Quick Access Toolbar. More...
 
EwErrorCode removeAll ()
 Remove all controls from Quick Access Toolbar. More...
 
IEwRibbonControlX insertControlAt (int iIndex, EwRibbonControlType eRibbonControlType, BSTR strCommand, EwErrorCode *errorCode)
 Insert a new control in Quick Access Toolbar. More...
 
EwErrorCode removeControlByID (int iControlID)
 Remove a control specified by the ID in Quick Access Toolbar. More...
 
EwErrorCode resetQuickAccessToolbar ()
 Resets default controls in Quick Access Toolbar. More...
 
IEwRibbonComboBoxControlX insertComboBoxControl (int nPosition, EwErrorCode *errorCode)
 Insert the ComboBox Control in Quick Access Toolbar. More...
 
IEwRibbonComboBoxControlX addComboBoxControl (EwErrorCode *errorCode)
 Add the ComboBox Control in Quick Access Toolbar. More...
 
IEwRibbonControlX addRibbonControl (int iControlID, EwRibbonControlType eType, BSTR strCommand, EwErrorCode *errorCode)
 Add an existing ribbon control at the end of Quick Access Toolbar. More...
 
EwErrorCode addToDefaultControls (int iControlID)
 Add control to the list of default controls in Quick Access Toolbar. More...
 

Detailed Description

Use this interface to manage the quick access control on Ribbon.

Since
2022 SP0

Member Function Documentation

◆ addComboBoxControl()

IEwRibbonComboBoxControlX IEwRibbonQuickAccessControlX::addComboBoxControl ( EwErrorCode *  errorCode)

Add the ComboBox Control in Quick Access Toolbar.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if wrong input is provided
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonComboBoxControlX object.

◆ addControl()

IEwRibbonControlX IEwRibbonQuickAccessControlX::addControl ( EwRibbonControlType  eRibbonControlType,
BSTR  strCommand,
EwErrorCode *  errorCode 
)

Add a new control at the end of Quick Access Toolbar.

Note
To add ComboBox Control use addComboBoxControl.
Parameters
[in]eRibbonControlTypetype of control
[in]strCommandthe name of a command to launch. Can be blanck.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized or EwRibbonControlType is invalid
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonControlX added to Quick Access Toolbar.

◆ addRibbonControl()

IEwRibbonControlX IEwRibbonQuickAccessControlX::addRibbonControl ( int  iControlID,
EwRibbonControlType  eType,
BSTR  strCommand,
EwErrorCode *  errorCode 
)

Add an existing ribbon control at the end of Quick Access Toolbar.

Since
2023 SP0.
Parameters
[in]iControlIDID of the control.
[in]eTypetype of control
[in]strCommandthe name of a command to launch. Can be blanck.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized or EwRibbonControlType is invalid
  • EW_OBJECT_NOT_FOUND if added control not found
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonControlX added to Quick Access Toolbar.

◆ addToDefaultControls()

EwErrorCode IEwRibbonQuickAccessControlX::addToDefaultControls ( int  iControlID)

Add control to the list of default controls in Quick Access Toolbar.

Since
2023 SP0.
Parameters
[in]iControlIDID of the control.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ findControlByID()

IEwRibbonControlX IEwRibbonQuickAccessControlX::findControlByID ( int  iControlId,
EwErrorCode *  errorCode 
)

Call this member to find the specified control in Quick Access Toolbar.

Parameters
[in]iControlIdID of the control.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if the control ID is negative or not present in Quick Access Toolbar.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonControlX to the control.

◆ getControlAt()

IEwRibbonControlX IEwRibbonQuickAccessControlX::getControlAt ( int  iIndex,
EwErrorCode *  errorCode 
)

Return the specified control of Quick Access Toolbar.

Parameters
[in]iIndexPosition of the control.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the index is negative or greater than the number of controls
  • EW_UNDEFINED_ERROR if another error occurred
Returns
An IEwRibbonControlX specified.

◆ getControlCount()

int IEwRibbonQuickAccessControlX::getControlCount ( EwErrorCode *  errorCode)

Return the number of controls in Quick Access Toolbar.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the number of controls in Quick Access Toolbar.

◆ getQuickAccessControlIDArray()

VARIANT IEwRibbonQuickAccessControlX::getQuickAccessControlIDArray ( EwErrorCode *  errorCode)

Call this member to get array of control IDs in Quick Access Toolbar.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized or EwRibbonControlType is invalid
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an Array of all the control IDs.

◆ insertComboBoxControl()

IEwRibbonComboBoxControlX IEwRibbonQuickAccessControlX::insertComboBoxControl ( int  nPosition,
EwErrorCode *  errorCode 
)

Insert the ComboBox Control in Quick Access Toolbar.

Parameters
[in]nPositionposition where button must be inserted in ribbon group
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if wrong input is provided
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonComboBoxControlX.

◆ insertControlAt()

IEwRibbonControlX IEwRibbonQuickAccessControlX::insertControlAt ( int  iIndex,
EwRibbonControlType  eRibbonControlType,
BSTR  strCommand,
EwErrorCode *  errorCode 
)

Insert a new control in Quick Access Toolbar.

Note
To insert ComboBox Control use insertComboBoxControl.
Parameters
[in]iIndexposition where button must be inserted in Quick Access Toolbar , if position is negative or higher than the number of control in Quick Access Toolbar, then the control will be added at the end of Quick Access Toolbar.
[in]eRibbonControlTypetype of ribbon control
[in]strCommandthe name of a command to launch. Can be blank.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized or EwRibbonControlType is invalid
  • EW_BAD_INPUT if eType is not a good type
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwRibbonControlX added to the control.

◆ removeAll()

EwErrorCode IEwRibbonQuickAccessControlX::removeAll ( )

Remove all controls from Quick Access Toolbar.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ removeControlAt()

EwErrorCode IEwRibbonQuickAccessControlX::removeControlAt ( int  iIndex)

Remove a control specified by the index in Quick Access Toolbar.

Also, this will remove the control from default control list.

Parameters
[in]iIndexthe index of the control to remove.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the index is greater than the number of control or negative.
  • EW_UNDEFINED_ERROR if another error occurred

◆ removeControlByID()

EwErrorCode IEwRibbonQuickAccessControlX::removeControlByID ( int  iControlID)

Remove a control specified by the ID in Quick Access Toolbar.

Also, this will remove the control from default control list.

Parameters
[in]iControlIDID of the control.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the index is greater than the number of control or negative.
  • EW_UNDEFINED_ERROR if another error occurred

◆ resetQuickAccessToolbar()

EwErrorCode IEwRibbonQuickAccessControlX::resetQuickAccessToolbar ( )

Resets default controls in Quick Access Toolbar.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Generated on Thu Aug 25 2022 16:02:39 for SOLIDWORKS Electrical API by doxygen 1.9.4


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: IEwRibbonQuickAccessControlX Interface Reference
*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) 2023 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.10