Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Enterprise PDM API HelpSOLIDWORKS Enterprise PDM API Help
Welcome
Release Notes
Getting Started
Expand Stand-alone ApplicationsStand-alone Applications
Expand Add-in ApplicationsAdd-in Applications
Collapse EPDM.Interop.epdm NamespaceEPDM.Interop.epdm Namespace
Overview
Collapse InterfacesInterfaces
Expand IEdmAddCustomRefsIEdmAddCustomRefs
Expand IEdmAddCustomRefs2IEdmAddCustomRefs2
Expand IEdmAddIn5IEdmAddIn5
Expand IEdmAddInDrawButton5IEdmAddInDrawButton5
Expand IEdmAddInMgr5IEdmAddInMgr5
Expand IEdmAddInMgr6IEdmAddInMgr6
Expand IEdmAddInMgr7IEdmAddInMgr7
Expand IEdmAddInMgr8IEdmAddInMgr8
Expand IEdmAttribute5IEdmAttribute5
Expand IEdmBatchAddIEdmBatchAdd
Expand IEdmBatchAdd2IEdmBatchAdd2
Expand IEdmBatchAddFoldersIEdmBatchAddFolders
Expand IEdmBatchChangeStateIEdmBatchChangeState
Expand IEdmBatchChangeState2IEdmBatchChangeState2
Expand IEdmBatchChangeState3IEdmBatchChangeState3
Expand IEdmBatchChangeState4IEdmBatchChangeState4
Expand IEdmBatchChangeState5IEdmBatchChangeState5
Expand IEdmBatchDeleteIEdmBatchDelete
Expand IEdmBatchDelete2IEdmBatchDelete2
Expand IEdmBatchDelete3IEdmBatchDelete3
Expand IEdmBatchGetIEdmBatchGet
Expand IEdmBatchItemGenerationIEdmBatchItemGeneration
Expand IEdmBatchItemGeneration2IEdmBatchItemGeneration2
Expand IEdmBatchItemReferenceUpdateIEdmBatchItemReferenceUpdate
Expand IEdmBatchListingIEdmBatchListing
Expand IEdmBatchListing2IEdmBatchListing2
Expand IEdmBatchListing3IEdmBatchListing3
Expand IEdmBatchRefVarsIEdmBatchRefVars
Expand IEdmBatchUnlockIEdmBatchUnlock
Expand IEdmBatchUnlock2IEdmBatchUnlock2
Expand IEdmBatchUpdate2IEdmBatchUpdate2
Expand IEdmBitmap5IEdmBitmap5
Expand IEdmBomIEdmBom
Expand IEdmBomCellIEdmBomCell
Expand IEdmBomMgrIEdmBomMgr
Expand IEdmBomViewIEdmBomView
Expand IEdmBomView2IEdmBomView2
Expand IEdmCallbackIEdmCallback
Expand IEdmCallback6IEdmCallback6
Expand IEdmCard5IEdmCard5
Expand IEdmCard6IEdmCard6
Expand IEdmCardControl5IEdmCardControl5
Expand IEdmCardControl6IEdmCardControl6
Expand IEdmCardView5IEdmCardView5
Expand IEdmCardView6IEdmCardView6
Expand IEdmCardView61IEdmCardView61
Expand IEdmCardView63IEdmCardView63
Expand IEdmCategory6IEdmCategory6
Expand IEdmCategoryMgr6IEdmCategoryMgr6
Expand IEdmClearLocalCacheIEdmClearLocalCache
Expand IEdmClearLocalCache2IEdmClearLocalCache2
Expand IEdmClearLocalCache3IEdmClearLocalCache3
Expand IEdmCmdMgr5IEdmCmdMgr5
Expand IEdmCmdNodeIEdmCmdNode
Expand IEdmDataIEdmData
Expand IEdmDictionary5IEdmDictionary5
Expand IEdmEnumIEdmEnum
Expand IEdmEnumeratorCustomReference5IEdmEnumeratorCustomReference5
Expand IEdmEnumeratorCustomReference6IEdmEnumeratorCustomReference6
Expand IEdmEnumeratorVariable10IEdmEnumeratorVariable10
Expand IEdmEnumeratorVariable5IEdmEnumeratorVariable5
Expand IEdmEnumeratorVariable6IEdmEnumeratorVariable6
Expand IEdmEnumeratorVariable7IEdmEnumeratorVariable7
Expand IEdmEnumeratorVariable8IEdmEnumeratorVariable8
Expand IEdmEnumeratorVariable9IEdmEnumeratorVariable9
Expand IEdmEnumeratorVersion5IEdmEnumeratorVersion5
Expand IEdmEnumeratorVersion6IEdmEnumeratorVersion6
Expand IEdmFile10IEdmFile10
Expand IEdmFile11IEdmFile11
Expand IEdmFile5IEdmFile5
Expand IEdmFile6IEdmFile6
Expand IEdmFile7IEdmFile7
Expand IEdmFile8IEdmFile8
Expand IEdmFile9IEdmFile9
Expand IEdmFindUserIEdmFindUser
Expand IEdmFolder5IEdmFolder5
Expand IEdmFolder6IEdmFolder6
Expand IEdmFolder7IEdmFolder7
Expand IEdmFolder8IEdmFolder8
Expand IEdmFolderData5IEdmFolderData5
Expand IEdmGetCSVersionDialogIEdmGetCSVersionDialog
Expand IEdmGetOpCallbackIEdmGetOpCallback
Expand IEdmGetOpCallback2IEdmGetOpCallback2
Expand IEdmGetOpCallback3IEdmGetOpCallback3
Expand IEdmHistoryIEdmHistory
Expand IEdmHistoryUpdateIEdmHistoryUpdate
Expand IEdmImageIEdmImage
Expand IEdmInbox5IEdmInbox5
Expand IEdmItemIEdmItem
Expand IEdmLabel5IEdmLabel5
Expand IEdmLabel6IEdmLabel6
Expand IEdmMenu5IEdmMenu5
Expand IEdmMenu6IEdmMenu6
Expand IEdmMenu7IEdmMenu7
Expand IEdmMessage5IEdmMessage5
Expand IEdmObject5IEdmObject5
Expand IEdmPos5IEdmPos5
Expand IEdmRawReferenceMgrIEdmRawReferenceMgr
Expand IEdmReference10IEdmReference10
Expand IEdmReference5IEdmReference5
Expand IEdmReference6IEdmReference6
Expand IEdmReference7IEdmReference7
Expand IEdmReference8IEdmReference8
Expand IEdmReference9IEdmReference9
Expand IEdmRefItemIEdmRefItem
Expand IEdmRefItemContainerIEdmRefItemContainer
Expand IEdmRevision5IEdmRevision5
Expand IEdmRevision6IEdmRevision6
Expand IEdmRevisionMgrIEdmRevisionMgr
Expand IEdmRevisionMgr2IEdmRevisionMgr2
Expand IEdmRevisionMgr3IEdmRevisionMgr3
Expand IEdmSearch5IEdmSearch5
Expand IEdmSearch6IEdmSearch6
Expand IEdmSearch7IEdmSearch7
Expand IEdmSearchResult5IEdmSearchResult5
Expand IEdmSelectionList5IEdmSelectionList5
Expand IEdmSelectionList6IEdmSelectionList6
Expand IEdmSerNoGen7IEdmSerNoGen7
Expand IEdmSerNoValueIEdmSerNoValue
Expand IEdmState5IEdmState5
Expand IEdmState6IEdmState6
Expand IEdmState7IEdmState7
Expand IEdmStrLst5IEdmStrLst5
Expand IEdmTaskInstanceIEdmTaskInstance
Expand IEdmTaskPropertiesIEdmTaskProperties
Expand IEdmTemplate5IEdmTemplate5
Expand IEdmTemplate53IEdmTemplate53
Expand IEdmTemplateMgr5IEdmTemplateMgr5
Expand IEdmTransition10IEdmTransition10
Expand IEdmTransition5IEdmTransition5
Expand IEdmTransition6IEdmTransition6
Expand IEdmTransition7IEdmTransition7
Expand IEdmTransition8IEdmTransition8
Expand IEdmTransition9IEdmTransition9
Expand IEdmUnlockOpCallbackIEdmUnlockOpCallback
Expand IEdmUpdateReferencesIEdmUpdateReferences
Expand IEdmUser10IEdmUser10
Expand IEdmUser5IEdmUser5
Expand IEdmUser6IEdmUser6
Expand IEdmUser7IEdmUser7
Expand IEdmUser8IEdmUser8
Expand IEdmUser9IEdmUser9
Expand IEdmUserGroup5IEdmUserGroup5
Expand IEdmUserGroup6IEdmUserGroup6
Expand IEdmUserGroup7IEdmUserGroup7
Expand IEdmUserGroup8IEdmUserGroup8
Expand IEdmUserMgr5IEdmUserMgr5
Expand IEdmUserMgr7IEdmUserMgr7
Expand IEdmUserMgr8IEdmUserMgr8
Expand IEdmVariable5IEdmVariable5
Expand IEdmVariableMgr5IEdmVariableMgr5
Expand IEdmVariableMgr6IEdmVariableMgr6
Expand IEdmVariableMgr7IEdmVariableMgr7
Expand IEdmVariableValue5IEdmVariableValue5
Expand IEdmVariableValue6IEdmVariableValue6
Expand IEdmVault10IEdmVault10
Expand IEdmVault11IEdmVault11
Expand IEdmVault12IEdmVault12
Expand IEdmVault13IEdmVault13
Expand IEdmVault14IEdmVault14
Expand IEdmVault15IEdmVault15
Expand IEdmVault5IEdmVault5
Expand IEdmVault6IEdmVault6
Expand IEdmVault7IEdmVault7
Expand IEdmVault8IEdmVault8
Expand IEdmVault9IEdmVault9
Expand IEdmVersion5IEdmVersion5
Expand IEdmVersion6IEdmVersion6
Expand IEdmVersion7IEdmVersion7
Expand IEdmWorkflow6IEdmWorkflow6
Expand IEdmWorkflowMgr6IEdmWorkflowMgr6
Expand EnumerationsEnumerations
Expand StructuresStructures
Expand EPDM.Interop.EPDMResultCode NamespaceEPDM.Interop.EPDMResultCode Namespace
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 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 SOLIDWORKS Workgroup PDM API HelpSOLIDWORKS Workgroup PDM API Help
Expand eDrawings API HelpeDrawings API Help
Hide Table of Contents
IEdmTaskInstance Interface

Allows you to access the task instance of an add-in.

Syntax

Visual Basic (Declaration) 
Public Interface IEdmTaskInstance
C# 
public interface IEdmTaskInstance
C++/CLI 
public interface class IEdmTaskInstance

Example

Remarks

This interface inherits from IDispatch. See IDispatch Interface (Automation). 

An instance of the task is created when the task is launched. This interface is created in EdmCmd::mpoExtra when an add-in calls IEdmAddIn5::OnCmd and has previously registered the hooks, EdmCmdType.EdmCmd_TaskRun, EdmCmdType.EdmCmd_TaskLaunch, EdmCmdType.EdmCmd_TaskDetails, using IEdmCmdMgr5::AddHook. After the task launches, IEdmTaskInstance can be used to prompt the user for user-defined variable values, display a data card for editing data card variables, or update the task list messages and progress bar as the task runs. 

Programming tasks are add-ins that allow you to specify when and where to perform specific tasks.  

The definition of the task can be used to modify the task setup page.

See Also



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:   IEdmTaskInstance Interface
*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) 2015 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.49