Click or drag to resize

TaskGroup Class

Implementation of ITaskGroup which groups ITask instances and / or other ITaskGroup instances.
Inheritance Hierarchy

Namespace:  SD.LLBLGen.Pro.ApplicationCore.CodeGenerationMetaData.Tasks
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.10.0.0 (5.10.0)
Syntax
public class TaskGroup : TaskGroupElement, ITaskGroup, 
	ITaskGroupElement, ISupportedAspectsInfo, INotifyAsChanged, IEnumerable, IEnumerable<TaskGroupElement>

The TaskGroup type exposes the following members.

Constructors
  NameDescription
Public methodTaskGroup
CTor
Top
Properties
  NameDescription
Public propertyAdditionalDestinationFolder
Gets / sets additionalDestinationFolder
Public propertyAdditionalRootNamespace
Gets / sets additionalRootNamespace
Public propertyContainerForcedEnableFlagState
Gets the forced enable flag state of the container of this element. If the container is disabled, or the container of the container (etc...) this element is also disabled, even though it's flag is set to Enabled.
(Inherited from TaskGroupElement.)
Public propertyContainingGroup
Gets / sets containingGroup
(Inherited from TaskGroupElement.)
Public propertyCount
The number of elements in this TaskGroup
Public propertyDependencies
Gets the names of the tasks/ taskgroups this task depends on.
(Inherited from TaskGroupElement.)
Public propertyDependsOnCycleTask
Gets or sets the depends on cycle task setting. Default is an empty string, which means this value is ignored. If set to a value, it's used at generation time to see whether a cycle task with the name specified has been completed successfully. If not, this task is simply skipped, otherwise it's run as-is.
(Inherited from TaskGroupElement.)
Public propertyDescription
Gets or sets the description of the element
(Inherited from TaskGroupElement.)
Public propertyDisplayName
Gets or sets the display name for this element. If display name isn't set or set to an empty string, Name is returned.
(Inherited from TaskGroupElement.)
Public propertyElementLogNode
Gets or sets the log node.
(Inherited from TaskGroupElement.)
Public propertyForSpecificDatabase
Gets or sets the perform for specific database setting. Default is an empty string (which gives the v2.x behavior: run once). Other possible values are "All" (run for all databases in the project once) or the driverID of the database to target.
(Inherited from TaskGroupElement.)
Public propertyIsChanged
Gets a value indicating whether this instance is changed.
(Inherited from TaskGroupElement.)
Public propertyIsEnabled
Gets / sets isEnabled. If the element isn't optional, setting this value is a no-op, as the value is always true in that case.
(Inherited from TaskGroupElement.)
Public propertyIsOptional
Gets / sets the isOptional flag setting for tasks and taskgroups. Optional tasks don't cause errors when they can't be completed.
(Inherited from TaskGroupElement.)
Public propertyItem
Indexer
Public propertyLogLineHandler
The handler of the LogLineInApplicationOutputCallBack. Setting this property will allow the generator and any task or taskgroup to log text on the application output window.
(Inherited from TaskGroupElement.)
Public propertyName
The name of the element
(Inherited from TaskGroupElement.)
Public propertyNameToUseForLogging
Name to use for logging of actions on task group element. This is by default the display name. If the display name differs from the Name, it will use the format: display name (name)
(Inherited from TaskGroupElement.)
Public propertyPerformRuleToUse
Gets or sets the perform rule to use.
(Inherited from TaskGroupElement.)
Public propertyRequiresCleanCache
Gets or sets a value indicating whether this task requires that the task cache is cleaned before the task is executed.
(Inherited from TaskGroupElement.)
Public propertySupportedFrameworks
Gets the supported frameworks.
(Inherited from TaskGroupElement.)
Public propertySupportedPlatforms
Gets the supported platform names.
(Inherited from TaskGroupElement.)
Public propertySupportedTemplateGroups
Gets the supported template group names
(Inherited from TaskGroupElement.)
Public propertyType
Type of the element
(Inherited from TaskGroupElement.)
Top
Methods
  NameDescription
Public methodAdd
Adds the given element to the ITaskGroup instance
Public methodClone
Creates a new object that is a copy of the current instance. Clones only itself, not the contents of this group.
(Overrides TaskGroupElementClone.)
Public methodClone(Boolean)
Creates a new object that is a copy of the current instance.
Protected methodCloneMembers
Clones the members of this object into the passed in clone.
(Overrides TaskGroupElementCloneMembers(Object).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFilterContents
Filters the contents.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetElementByName
Gets the elements with the name specified or null if not found.
Public methodStatic memberGetFullAdditionalDestinationFolder
Gets the full additional destination folder, starting with the root of the containing hierarchy of taskgroups, appending every additional destination folder along the path towards the passed in taskgroup, including the additional destination folder of that taskgroup. If the taskgroup is null, an empty string is returned.
Public methodStatic memberGetFullAdditionalRootNamespace
Gets the full additional root namespace, starting with the root of the containing hierarchy of taskgroups, appending every additional namespace along the path towards the passed in taskgroup, including the additional namespace of that taskgroup. If the taskgroup is null, an empty string is returned.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetListOfDriverIDsToProcess
Gets the list of driver IDs to process.
(Inherited from TaskGroupElement.)
Public methodGetNumberOfStepsToPerform
Gets the number of steps to perform. This can be different from the number of tasks as a taskgroup might be executed multiple times.
Public methodGetNumberOfTasks
Gets the total amount of tasks contained in this group and contained groups.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
returns the index of the element in this group.
Public methodInsert
Inserts the passed in element at the index specified
Public methodLoadTaskPerformerAssemblies
Loads for each task in the group the task performer assembly and class and adds the instance to the task instance
Protected methodLogLine
Logs the given line to the output window. Based on the verbose checkbox and the VerboseMessage flag the message is logged or not. If the verbose checkbox is set, also lines with VerboseMessage=true will be logged, otherwise these messages will be surpressed. Appends a newline if AppendNewLine is set to true.
(Inherited from TaskGroupElement.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMoveElementDown
Moves the element down.
Public methodMoveElementUp
Moves the element up.
Protected methodOnChanged
Called when [changed].
(Inherited from TaskGroupElement.)
Public methodPerform
Makes sure the element is performed. If the element is an ITaskGroup, all tasks and taskgroups inside the taskgroup are performed. If the element is an ITask, the Perform method of the ITaskperformer is called.
(Inherited from TaskGroupElement.)
Protected methodPerformElement
Performs the element. If the element is an ITaskGroup, all tasks and taskgroups inside the taskgroup are performed. If the element is an ITask, the Perform method of the ITaskperformer is called.
(Overrides TaskGroupElementPerformElement(IGenerator, LogNode).)
Public methodRemove
Removes the first occurence of the passed in element from this taskgroup
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventHasBeenChanged
Raised when the implementing element has been changed
(Inherited from TaskGroupElement.)
Top
Extension Methods
  NameDescription
Public Extension MethodSetEqualTaskGroupElement(IEnumerableTaskGroupElement)Overloaded.
Checks whether the enumerable to compare with is equal to the source enumerable, element wise. If elements are in a different order, the method will still return true. This is different from SequenceEqual which does take order into account
(Defined by IEnumerableExtensionMethods.)
Public Extension MethodSetEqualTaskGroupElement(IEnumerableTaskGroupElement, IEqualityComparerTaskGroupElement)Overloaded.
Checks whether the enumerable to compare with is equal to the source enumerable, element wise. If elements are in a different order, the method will still return true. This is different from SequenceEqual which does take order into account
(Defined by IEnumerableExtensionMethods.)
Public Extension MethodToFilteringBindingListTaskGroupElement
Converts the passed in enumerable to a FilteringBindingList
(Defined by ExtensionMethods.)
Public Extension MethodToHashSetTaskGroupElement
Creates a new hashset and adds the source to it.
(Defined by IEnumerableExtensionMethods.)
Public Extension MethodToListSafeTaskGroupElement
Converts the passed in enumerable to a List(Of T). If toEnumerate is a CommandifiedList(Of T) it will lock on its SyncRoot if it's a synchronized CommandifiedList. if it's not a commandified list, it will simply call ToList() on the enumerable. If toEnumerate is null, null is returned.
(Defined by ExtensionMethods.)
Public Extension MethodToReadOnlyCollectionTDestination
Converts the enumerable to a ReadOnlyCollection.
(Defined by IEnumerableExtensionMethods.)
Top
Explicit Interface Implementations
See Also