Click or drag to resize
Task Class
Implementation of ITask. Will be stored in ITaskGroup instances and reflect a single task to perform.
Inheritance Hierarchy

Namespace:  SD.LLBLGen.Pro.ApplicationCore.CodeGenerationMetaData.Tasks
Assembly:  SD.LLBLGen.Pro.ApplicationCore (in SD.LLBLGen.Pro.ApplicationCore.dll) Version: 5.1.0.0 (5.1.0)
Syntax
public class Task : TaskGroupElement, ITask, ITaskGroupElement, 
	ISupportedAspectsInfo, INotifyAsChanged

The Task type exposes the following members.

Constructors
  NameDescription
Public methodTask
CTor
Top
Properties
  NameDescription
Public propertyAssemblyFilename
The filename of the assembly which holds the code for the task performer class
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 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 propertyElementSelectionRuleToUse
Gets or sets the element selection rule. This rule is used to select elements (if set) which participate in this task.
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 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 propertyParameters
The list of parameters of this task.
Public propertyPerformer
The performer instance which will be used to perform this task.
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 propertyTaskPerformerClass
The classname of the performer of this task.
Public propertyType
Type of the element
(Inherited from TaskGroupElement.)
Top
Methods
  NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
(Overrides TaskGroupElementClone.)
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.)
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.
(Inherited from TaskGroupElement.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLoadTaskPerformerAssembly
Loads for this task the task performer assembly and class and adds the instance to this 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.)
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 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
See Also