Click or drag to resize
TaskGroupElement Class
Implementation of ITaskGroupElement and is the base class for Task and TaskGroup.
Inheritance Hierarchy

Namespace:  SD.LLBLGen.Pro.ApplicationCore.CodeGenerationMetaData.Tasks
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.2.0.0 (5.2.17.0403)
Syntax
public abstract class TaskGroupElement : ITaskGroupElement, 
	ISupportedAspectsInfo, INotifyAsChanged

The TaskGroupElement type exposes the following members.

Constructors
  NameDescription
Protected methodTaskGroupElement
Initializes a new instance of the TaskGroupElement class.
Protected methodTaskGroupElement(TaskGroupElementType)
Initializes a new instance of the TaskGroupElement class.
Top
Properties
  NameDescription
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.
Public propertyContainingGroup
Gets / sets containingGroup
Public propertyDependencies
Gets the names of the tasks/ taskgroups this task depends on.
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.
Public propertyDescription
Gets or sets the description of the element
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.
Public propertyElementLogNode
Gets or sets the log node.
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.
Public propertyIsChanged
Gets a value indicating whether this instance is changed.
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.
Public propertyIsOptional
Gets / sets the isOptional flag setting for tasks and taskgroups. Optional tasks don't cause errors when they can't be completed.
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.
Public propertyName
The name of the element
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)
Public propertyPerformRuleToUse
Gets or sets the perform rule to use.
Public propertyRequiresCleanCache
Gets or sets a value indicating whether this task requires that the task cache is cleaned before the task is executed.
Public propertySupportedFrameworks
Gets the supported frameworks.
Public propertySupportedPlatforms
Gets the supported platform names.
Public propertySupportedTemplateGroups
Gets the supported template group names
Public propertyType
Type of the element
Top
Methods
  NameDescription
Public methodClone
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.
Public methodStatic memberCreateDescriptionForForSpecificDatabaseProperty
Creates the description for for specific database property.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetListOfDriverIDsToProcess
Gets the list of driver IDs to process.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
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.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnChanged
Called when [changed].
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.
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.
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
Top
See Also