Table of Contents

Class WindowsClassicScheduledTask

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents a class scheduled task on a Windows machine.

public class WindowsClassicScheduledTask : GlobalSerializableClassicBase, IComparable<WindowsClassicScheduledTask>
Inheritance
WindowsClassicScheduledTask
Implements

Constructors

WindowsClassicScheduledTask()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.WindowsClassicScheduledTask class.

public WindowsClassicScheduledTask()

Properties

AccountName

Gets or sets the name of the user account that is used to start this scheduled task - for example "CORP\Administrator".

public string AccountName { get; set; }

Property Value

string

ApplicationName

Gets or sets the absolute path of the application to execute.

public string ApplicationName { get; set; }

Property Value

string

Comment

Gets or sets the description of this scheduled task.

public string Comment { get; set; }

Property Value

string

Creator

Gets or sets the name of the user account that created this scheduled task - for example "SYSTEM".

public string Creator { get; set; }

Property Value

string

DeleteWhenNotScheduled

Gets or sets whether the scheduled tasks will delete the task if it is not scheduled to run again.

public BooleanOption DeleteWhenNotScheduled { get; set; }

Property Value

BooleanOption

DontStartIfOnBatteries

Gets or sets whether scheduled tasks is configured to not start the task if the computer is running on batteries.

public BooleanOption DontStartIfOnBatteries { get; set; }

Property Value

BooleanOption

Enabled

Gets or sets whether this scheduled task is enabled.

public BooleanOption Enabled { get; set; }

Property Value

BooleanOption

ExitCode

Gets or sets the Win32 exit code from the last execution of this scheduled task.

public int ExitCode { get; set; }

Property Value

int

IdleWaitDeadlineMinutes

Gets or sets the amount of time in minutes that scheduled tasks will wait until the computer has been idle for IdleWaitMinutes so that the task can be run. This setting only applies if StartOnlyIfIdle is true.

public int IdleWaitDeadlineMinutes { get; set; }

Property Value

int

IdleWaitMinutes

Gets or sets the amount of time in minutes that a computer has to be idle before starting the task. This only applies when StartOnlyIfIdle is true.

public int IdleWaitMinutes { get; set; }

Property Value

int

KillIfGoingOnBatteries

Gets or sets whether scheduled tasks is configured to stop the task if battery mode begins.

public BooleanOption KillIfGoingOnBatteries { get; set; }

Property Value

BooleanOption

KillOnIdleEnd

Gets or sets whether scheduled tasks should stop the task if the computer ceases to be idle.

public BooleanOption KillOnIdleEnd { get; set; }

Property Value

BooleanOption

LastRunTime

Gets or sets the last run time (or DateTime.MinValue if it has never run).

public DateTime LastRunTime { get; set; }

Property Value

DateTime

MaxRunTime

Gets or sets the maximum time the task can run in minutes before it is terminated.

public int MaxRunTime { get; set; }

Property Value

int

MaxRunTimeString

Gets the maximum time the task can run before it is terminated.

public string MaxRunTimeString { get; }

Property Value

string

Name

Gets or sets the name of the Scheduled Task, as seen in the scheduled tasks user interface.

public string Name { get; set; }

Property Value

string

NextRunTime

Gets or sets the date and time at which this scheduled task is configured to run.

public DateTime NextRunTime { get; set; }

Property Value

DateTime

Parameters

Gets or sets the command line parameters configured for this scheduled task.

public string Parameters { get; set; }

Property Value

string

RunOnlyIfLoggedOn

Gets or sets whether this task will only run if the user is logged on.

public BooleanOption RunOnlyIfLoggedOn { get; set; }

Property Value

BooleanOption

Schedules

Gets or sets the human readable representation of the schedules for the task - for example "At 11:42 every day, starting 08.09.2011 Every 20 minute(s) from 00:49 for 2400 hour(s)".

public SerializableStringCollection Schedules { get; set; }

Property Value

SerializableStringCollection

StartOnlyIfIdle

Gets or sets whether this scheduled task will only start if the computer is idle.

public BooleanOption StartOnlyIfIdle { get; set; }

Property Value

BooleanOption

Status

Gets or sets a human readable representation of the status of this scheduled task.

public string Status { get; set; }

Property Value

string

WakeComputer

Gets or sets whether scheduled tasks should wake the computer before running this task.

public BooleanOption WakeComputer { get; set; }

Property Value

BooleanOption

WorkingDirectory

Gets or sets the absolute path of the working directory for this task.

public string WorkingDirectory { get; set; }

Property Value

string

Methods

CompareTo(WindowsClassicScheduledTask)

Compares two CENTREL.XIA.Configuration.Types.WindowsClassicScheduledTask objects to allow sorting alphabetically by scheduled task name.

public int CompareTo(WindowsClassicScheduledTask other)

Parameters

other WindowsClassicScheduledTask

The CENTREL.XIA.Configuration.Types.WindowsClassicScheduledTask to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.WindowsClassicScheduledTask objects.