General.ShowDescriptionForm Method

Public Shared Function ShowDescriptionForm( _ 
   ByVal type As ChangeDescriptionType, _ 
   ByVal entity_id As EntityID, _ 
   ByVal entity_type As EntityType, _ 
   ByRef description As String, _ 
   Optional ByVal parent As IWin32Window = null _ 
) As Boolean

This language is not supported or no code example is available.

public static bool ShowDescriptionForm( 
   ChangeDescriptionType type, 
   EntityID entity_id, 
   EntityType entity_type, 
   out string description, 
   IWin32Window parent = null 
)

This language is not supported or no code example is available.

public:  
static bool ShowDescriptionForm( 
   ChangeDescriptionType type, 
   EntityID^ entity_id, 
   EntityType entity_type, 
   String^& description, 
   IWin32Window^ parent 
) 

This language is not supported or no code example is available.

public static function ShowDescriptionForm( 
    type : ChangeDescriptionType, 
    entity_id : EntityID, 
    entity_type : EntityType, 
    description : String, 
    parent : IWin32Window 
) : boolean;

This language is not supported or no code example is available.

Parameters

type

Type: ChangeDescriptionType

The type of change being made: 0 = FileChanged, 1 = FileAdded, 2 = FolderChanged, 3 = TaskItemChanged, 4 = TDModelProjectChanged

entity_id

Type: EntityID

ID of the entity

entity_type

Type: EntityType

Type of the entity

description

Type: string

The description entered by the user

parent

Type: IWin32Window

Parent IWin32Window

Return Value

.NET Framework