Click or drag to resize
Task Scheduler Managed Class Library

Trigger Class

Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using the AddTTrigger(TTrigger) or the AddNew(TaskTriggerType) method.
Inheritance Hierarchy
SystemObject
  Microsoft.Win32.TaskSchedulerTrigger
    More

Namespace: Microsoft.Win32.TaskScheduler
Assembly: Microsoft.Win32.TaskScheduler (in Microsoft.Win32.TaskScheduler.dll) Version: 2.12.0
Syntax
C#
public abstract class Trigger : IDisposable, 
	ICloneable, IEquatable<Trigger>, IComparable, IComparable<Trigger>, 
	INotifyPropertyChanged
Request Example View Source

The Trigger type exposes the following members.

Properties
 NameDescription
Public propertyEnabledGets or sets a Boolean value that indicates whether the trigger is enabled.
Public propertyEndBoundary Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated.
Note  Note
While the maximum value for this property is MaxValue, the Windows Task Scheduler management application that is part of the OS will fail if this value is greater than December 31, 9998.
Public propertyExecutionTimeLimit Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task Scheduler 1.0.
Public propertyIdGets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0.
Public propertyRepetition Gets a RepetitionPattern instance that indicates how often the task is run and how long the repetition pattern is repeated after the task is started.
Public propertyStartBoundaryGets or sets the date and time when the trigger is activated.
Public propertyTriggerTypeGets the type of the trigger.
Top
Methods
 NameDescription
Protected methodCheckBindValueChecks the bind value for any conversion.
Public methodCloneCreates a new Trigger that is an unbound copy of this instance.
Public methodCompareTo Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
Public methodCopyProperties Copies the properties from another Trigger the current instance. This will not copy any properties associated with any derived triggers except those supporting the ITriggerDelay interface.
Public methodStatic memberCreateTriggerCreates the specified trigger.
Public methodDisposeReleases all resources used by this class.
Public methodEquals(Object)Determines whether the specified Object, is equal to this instance.
(Overrides ObjectEquals(Object))
Public methodEquals(Trigger)Indicates whether the current object is equal to another object of the same type.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodStatic memberFromCronFormatCreates a trigger using a cron string.
Public methodGetHashCodeReturns a hash code for this instance.
(Overrides ObjectGetHashCode)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodGetUnboundValueOrDefaultTGets the unbound value or a default.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnNotifyPropertyChangedCalled when a property has changed to notify any attached elements.
Public methodSetRepetitionObsolete.
Sets the repetition.
Public methodToStringReturns a string representing this trigger.
(Overrides ObjectToString)
Public methodToString(CultureInfo)Returns a String that represents this trigger in a specific language.
Protected methodV2GetTriggerStringGets the non-localized trigger string for V2 triggers.
Top
Events
 NameDescription
Public eventPropertyChangedOccurs when a property value changes.
Top
Fields
 NameDescription
Protected fieldunboundValuesIn testing and may change. Do not use until officially introduced into library.
Top
See Also
Inheritance Hierarchy