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 SampleSample
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
IEwProjectWireStyleManagerX
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 2024.0.0
Electrical API
IEwNotificationDialogX Interface Reference

Use this interface to manage notification dialog. More...

Inheritance diagram for IEwNotificationDialogX:
Inheritance graph

Public Member Functions

BSTR getMessage (EwErrorCode *errorCode)
 Return the Message of the Notification Dialog. More...
 
EwErrorCode setMessage (BSTR strMessage)
 Set a new Message for the Notification Dialog. More...
 
EwNotificationMessageType getMessageType (EwErrorCode *errorCode)
 Get an EwNotificationMessageType enum value, an enumeration Message Type of the Notification Dialog. More...
 
EwErrorCode setMessageType (EwNotificationMessageType eNotificationDialogMessageType)
 Set an EwNotificationMessageType enum value, an enumeration Message Type of the Notification Dialog. More...
 
BSTR getTitle (EwErrorCode *errorCode)
 Return the Title of the Notification Dialog. More...
 
EwErrorCode setTitle (BSTR strTitle)
 Set a new Title for the Notification Dialog. More...
 
int getXPosition (EwErrorCode *errorCode)
 Get the horizontal position in screen coordinates of the Notification Dialog. More...
 
EwErrorCode setXPosition (int iXCoordinate)
 Set the horizontal position in screen coordinates of the Notification Dialog. More...
 
int getYPosition (EwErrorCode *errorCode)
 Get the vertical position in screen coordinates of the top of the menu on the screen. More...
 
EwErrorCode setYPosition (int iYCoordinate)
 Set the vertical position in screen coordinates of the top of the menu on the screen. More...
 
VARIANT_BOOL isHyperlinkSupported (EwErrorCode *errorCode)
 Determine if hyperlink support is enabled. More...
 
EwErrorCode setHyperlinkSupport (VARIANT_BOOL bShowHyperlink)
 Set to enable hyperlink support for a text item. More...
 
int getShowDelayTime (EwErrorCode *errorCode)
 Get the time in milliseconds after which the dialog will auto close. More...
 
EwErrorCode setShowDelayTime (int nShowDelayTime)
 Set the time in milliseconds after which the dialog will auto close. More...
 
EwErrorCode show ()
 Display a message in a bubble at a specific point. More...
 
EwErrorCode close ()
 Close the notification dialog. More...
 
VARIANT_BOOL isStackNotificationEnabled (EwErrorCode *errorCode)
 Determine if stack notification is enabled. More...
 
EwErrorCode setStackNotification (VARIANT_BOOL bStackNotification)
 Set to enable stack notifications. More...
 

Detailed Description

Use this interface to manage notification dialog.

Since
2023 SP1

Member Function Documentation

◆ close()

EwErrorCode IEwNotificationDialogX::close ( )

Close the notification dialog.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ getMessage()

BSTR IEwNotificationDialogX::getMessage ( EwErrorCode errorCode)

Return the Message of the Notification Dialog.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the Message of the Notification Dialog.

◆ getMessageType()

EwNotificationMessageType IEwNotificationDialogX::getMessageType ( EwErrorCode errorCode)

Get an EwNotificationMessageType enum value, an enumeration Message Type of the Notification Dialog.

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 EwNotificationMessageType enum value.

◆ getShowDelayTime()

int IEwNotificationDialogX::getShowDelayTime ( EwErrorCode errorCode)

Get the time in milliseconds after which the dialog will auto close.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected
Returns
time in milliseconds after which the dialog auto close.

◆ getTitle()

BSTR IEwNotificationDialogX::getTitle ( EwErrorCode errorCode)

Return the Title of the Notification Dialog.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the Title of the Notification Dialog.

◆ getXPosition()

int IEwNotificationDialogX::getXPosition ( EwErrorCode errorCode)

Get the horizontal position in screen coordinates of the Notification Dialog.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected
Returns
the horizontal position in screen coordinates of the Notification Dialog.

◆ getYPosition()

int IEwNotificationDialogX::getYPosition ( EwErrorCode errorCode)

Get the vertical position in screen coordinates of the top of the menu on the screen.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected
Returns
the vertical position in screen coordinates of the top of the menu on the screen.

◆ isHyperlinkSupported()

VARIANT_BOOL IEwNotificationDialogX::isHyperlinkSupported ( EwErrorCode errorCode)

Determine if hyperlink support is enabled.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected
Returns
TRUE if hyperlink support is enabled, otherwise FALSE.

◆ isStackNotificationEnabled()

VARIANT_BOOL IEwNotificationDialogX::isStackNotificationEnabled ( EwErrorCode errorCode)

Determine if stack notification is enabled.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected
Returns
TRUE if stack notification is enabled, otherwise FALSE.

◆ setHyperlinkSupport()

EwErrorCode IEwNotificationDialogX::setHyperlinkSupport ( VARIANT_BOOL  bShowHyperlink)

Set to enable hyperlink support for a text item.

Parameters
[in]bShowHyperlink- TRUE to enable hyperlink support, FALSE otherwise.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected

◆ setMessage()

EwErrorCode IEwNotificationDialogX::setMessage ( BSTR  strMessage)

Set a new Message for the Notification Dialog.

Parameters
[in]strMessagethe new Message to display.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected

◆ setMessageType()

EwErrorCode IEwNotificationDialogX::setMessageType ( EwNotificationMessageType  eNotificationDialogMessageType)

Set an EwNotificationMessageType enum value, an enumeration Message Type of the Notification Dialog.

Parameters
[in]eNotificationDialogMessageTypeThe Message Type of the Notification Dialog. Can be any of the values listed in the EwNotificationMessageType enum.
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 buttonStyle is not a good button style.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setShowDelayTime()

EwErrorCode IEwNotificationDialogX::setShowDelayTime ( int  nShowDelayTime)

Set the time in milliseconds after which the dialog will auto close.

Parameters
[in]nShowDelayTimethe Y-Coordinate of the Menu
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_BAD_INPUTS if the time in milliseconds is less than zero
  • EW_NO_ERROR if no error detected

◆ setStackNotification()

EwErrorCode IEwNotificationDialogX::setStackNotification ( VARIANT_BOOL  bStackNotification)

Set to enable stack notifications.

Parameters
[in]bStackNotification- TRUE to stack notifications, FALSE otherwise.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected

◆ setTitle()

EwErrorCode IEwNotificationDialogX::setTitle ( BSTR  strTitle)

Set a new Title for the Notification Dialog.

Parameters
[in]strTitlethe new Title to display.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected

◆ setXPosition()

EwErrorCode IEwNotificationDialogX::setXPosition ( int  iXCoordinate)

Set the horizontal position in screen coordinates of the Notification Dialog.

Parameters
[in]iXCoordinatethe X-Coordinate of the Menu
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected

◆ setYPosition()

EwErrorCode IEwNotificationDialogX::setYPosition ( int  iYCoordinate)

Set the vertical position in screen coordinates of the top of the menu on the screen.

Parameters
[in]iYCoordinatethe Y-Coordinate of the Menu
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if the reason for error is unknown
  • EW_NO_ERROR if no error detected

◆ show()

EwErrorCode IEwNotificationDialogX::show ( )

Display a message in a bubble at a specific point.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred


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: IEwNotificationDialogX 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) 2024 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.