TaskTypeInfo Class: Difference between revisions

Revision as of 21:47, 12 March 2014

Used with the Repository.GetAllTaskTypes to get information about all the tasks in a repository.

ID (as integer) Sets or returns the Task type ID
Name (as string) Sets or returns the Task Type Name
Classification (as TaskClassEnum) Sets or returns the Task Type classification
Abbreviation (as string) Sets or returns the abbreviation for the task type

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Get the list of task types in the connected repository from the current project.

       Dim ListOfTaskTypes() As TaskTypeInfo
       ListOfTaskTypes = MyRepository.GetAllTaskTypes()

@@ Line 7: / Line 7: @@
 *Classification (as ''[[TaskClassEnum Enumeration|TaskClassEnum]]'') {{APIComment|Sets or returns the Task Type classification}}
 *Abbreviation (as ''string'') {{APIComment|Sets or returns the abbreviation for the task type}}
+== Usage Example ==
+{{APIComment|Declare a new repository connection class.}}
+        Private WithEvents MyRepository As New Repository
+{{APIComment|Connect to the Synthesis repository.}}
+        Dim Success As Boolean = False
+        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
+{{APIComment|Get the list of task types in the connected repository from the current project.}}
+        Dim ListOfTaskTypes() As [[TaskTypeInfo Class|TaskTypeInfo]]
+        ListOfTaskTypes = MyRepository.GetAllTaskTypes()