Skip to content

Commit 322416a

Browse files
author
David Hall
committed
* Updated help docs
1 parent f700363 commit 322416a

File tree

1,157 files changed

+1741
-1684
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,157 files changed

+1741
-1684
lines changed

TaskSchedulerHelp/TaskSchedulerHelp.shfbproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@
113113
<NamespaceSummaryItem name="Microsoft.Win32.TaskScheduler.UIComponents" isDocumented="True">The Microsoft.Win32.TaskScheduler.UIComponents namespace includes Windows Forms controls that can be used to represent triggers and actions.</NamespaceSummaryItem>
114114
<NamespaceSummaryItem name="System.Reflection" isDocumented="False" />
115115
</NamespaceSummaries>
116-
<HelpFileVersion>2.6.2</HelpFileVersion>
116+
<HelpFileVersion>2.6.3</HelpFileVersion>
117117
<HelpFileFormat>MSHelpViewer, Website</HelpFileFormat>
118118
<CopyrightHref>https://github.com/dahall/TaskScheduler/blob/master/license.md</CopyrightHref>
119119
<SdkLinkTarget>Blank</SdkLinkTarget>

TaskService/TaskFolder.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,6 @@ public IEnumerable<TaskFolder> EnumerateFolders(Predicate<TaskFolder> filter = n
275275
if (filter == null || filter(fld))
276276
yield return fld;
277277
}
278-
279278
}
280279

281280
/// <summary>Returns an enumerable collection of tasks that matches a specified filter and recursion option.</summary>

docs/Microsoft.Win32.TaskScheduler.xml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@
2323
A new object that is a copy of this instance.
2424
</returns>
2525
</member>
26+
<member name="M:Microsoft.Win32.TaskScheduler.Action.CompareTo(Microsoft.Win32.TaskScheduler.Action)">
27+
<summary>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.</summary>
28+
<param name="obj">An object to compare with this instance.</param>
29+
<returns>A value that indicates the relative order of the objects being compared.</returns>
30+
</member>
2631
<member name="M:Microsoft.Win32.TaskScheduler.Action.CreateAction(Microsoft.Win32.TaskScheduler.TaskActionType)">
2732
<summary>
2833
Creates the specified action.
@@ -2011,6 +2016,11 @@
20112016
Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials that are used to register the task, and the properties that describe the task.
20122017
</summary>
20132018
</member>
2019+
<member name="M:Microsoft.Win32.TaskScheduler.Task.CompareTo(Microsoft.Win32.TaskScheduler.Task)">
2020+
<summary>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.</summary>
2021+
<param name="other">An object to compare with this instance.</param>
2022+
<returns>A value that indicates the relative order of the objects being compared.</returns>
2023+
</member>
20142024
<member name="P:Microsoft.Win32.TaskScheduler.Task.Definition">
20152025
<summary>
20162026
Gets the definition of the task.
@@ -4485,6 +4495,11 @@
44854495
A new <see cref="T:Microsoft.Win32.TaskScheduler.Trigger" /> that is an unbound copy of this instance.
44864496
</returns>
44874497
</member>
4498+
<member name="M:Microsoft.Win32.TaskScheduler.Trigger.CompareTo(Microsoft.Win32.TaskScheduler.Trigger)">
4499+
<summary>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.</summary>
4500+
<param name="other">An object to compare with this instance.</param>
4501+
<returns>A value that indicates the relative order of the objects being compared.</returns>
4502+
</member>
44884503
<member name="M:Microsoft.Win32.TaskScheduler.Trigger.CopyProperties(Microsoft.Win32.TaskScheduler.Trigger)">
44894504
<summary>
44904505
Copies the properties from another <see cref="T:Microsoft.Win32.TaskScheduler.Trigger" /> the current instance. This will not copy any properties associated with any derived triggers except those supporting the <see cref="T:Microsoft.Win32.TaskScheduler.ITriggerDelay" /> interface.

docs/Microsoft.Win32.TaskSchedulerEditor.xml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1215,14 +1215,16 @@
12151215
<param name="editable">If set to <c>true</c> the task will be editable in the dialog.</param>
12161216
<param name="registerOnAccept">If set to <c>true</c> the task will be registered when OK is pressed.</param>
12171217
</member>
1218-
<member name="M:Microsoft.Win32.TaskScheduler.TaskEditDialog.#ctor(Microsoft.Win32.TaskScheduler.TaskService,Microsoft.Win32.TaskScheduler.TaskDefinition,System.Boolean,System.Boolean)">
1218+
<member name="M:Microsoft.Win32.TaskScheduler.TaskEditDialog.#ctor(Microsoft.Win32.TaskScheduler.TaskService,Microsoft.Win32.TaskScheduler.TaskDefinition,System.Boolean,System.Boolean,System.String,System.String)">
12191219
<summary>
12201220
Initializes a new instance of the <see cref="T:Microsoft.Win32.TaskScheduler.TaskEditDialog" /> class.
12211221
</summary>
12221222
<param name="service">A <see cref="P:Microsoft.Win32.TaskScheduler.TaskEditDialog.TaskService" /> instance.</param>
12231223
<param name="td">An optional <see cref="P:Microsoft.Win32.TaskScheduler.TaskEditDialog.TaskDefinition" />. Leaving null creates a new task.</param>
12241224
<param name="editable">If set to <c>true</c> the task will be editable in the dialog.</param>
12251225
<param name="registerOnAccept">If set to <c>true</c> the task will be registered when OK is pressed.</param>
1226+
<param name="taskName">If set, assigns this name to the task's name field.</param>
1227+
<param name="taskFolder">If set, assigns this path to the task's folder.</param>
12261228
</member>
12271229
<member name="P:Microsoft.Win32.TaskScheduler.TaskEditDialog.AvailableTabs">
12281230
<summary>
@@ -1251,12 +1253,14 @@
12511253
</summary>
12521254
<param name="task">A <see cref="P:Microsoft.Win32.TaskScheduler.TaskEditDialog.Task" /> instance.</param>
12531255
</member>
1254-
<member name="M:Microsoft.Win32.TaskScheduler.TaskEditDialog.Initialize(Microsoft.Win32.TaskScheduler.TaskService,Microsoft.Win32.TaskScheduler.TaskDefinition)">
1256+
<member name="M:Microsoft.Win32.TaskScheduler.TaskEditDialog.Initialize(Microsoft.Win32.TaskScheduler.TaskService,Microsoft.Win32.TaskScheduler.TaskDefinition,System.String,System.String)">
12551257
<summary>
12561258
Initializes the control for the editing of a new <see cref="P:Microsoft.Win32.TaskScheduler.TaskEditDialog.TaskDefinition" />.
12571259
</summary>
12581260
<param name="service">A <see cref="P:Microsoft.Win32.TaskScheduler.TaskEditDialog.TaskService" /> instance.</param>
12591261
<param name="td">An optional <see cref="P:Microsoft.Win32.TaskScheduler.TaskEditDialog.TaskDefinition" />. Leaving null creates a new task.</param>
1262+
<param name="taskName">If set, assigns this name to the task's name field.</param>
1263+
<param name="taskFolder">If set, assigns this path to the task's folder.</param>
12601264
</member>
12611265
<member name="P:Microsoft.Win32.TaskScheduler.TaskEditDialog.MaxHistoryCount">
12621266
<summary>
@@ -1620,12 +1624,14 @@
16201624
</summary>
16211625
<param name="taskInstance">A <see cref="P:Microsoft.Win32.TaskScheduler.TaskPropertiesControl.Task" /> instance.</param>
16221626
</member>
1623-
<member name="M:Microsoft.Win32.TaskScheduler.TaskPropertiesControl.Initialize(Microsoft.Win32.TaskScheduler.TaskService,Microsoft.Win32.TaskScheduler.TaskDefinition)">
1627+
<member name="M:Microsoft.Win32.TaskScheduler.TaskPropertiesControl.Initialize(Microsoft.Win32.TaskScheduler.TaskService,Microsoft.Win32.TaskScheduler.TaskDefinition,System.String,System.String)">
16241628
<summary>
16251629
Initializes the control for the editing of a new <see cref="P:Microsoft.Win32.TaskScheduler.TaskPropertiesControl.TaskDefinition" />.
16261630
</summary>
16271631
<param name="service">A <see cref="P:Microsoft.Win32.TaskScheduler.TaskPropertiesControl.TaskService" /> instance.</param>
16281632
<param name="taskDef">An optional <see cref="P:Microsoft.Win32.TaskScheduler.TaskPropertiesControl.TaskDefinition" />. Leaving null creates a new task.</param>
1633+
<param name="taskName">If set, assigns this name to the task's name field.</param>
1634+
<param name="taskFolder">If set, assigns this path to the task's folder.</param>
16291635
</member>
16301636
<member name="P:Microsoft.Win32.TaskScheduler.TaskPropertiesControl.IsV2">
16311637
<summary>

docs/TaskScheduler.mshc

12.8 KB
Binary file not shown.

docs/WebKI.xml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
<HelpKINode Title="Action property" Url="html/P_Microsoft_Win32_TaskScheduler_ActionEditDialog_Action.htm" />
1515
<HelpKINode Title="Action.ActionType property" Url="html/P_Microsoft_Win32_TaskScheduler_Action_ActionType.htm" />
1616
<HelpKINode Title="Action.Clone method" Url="html/M_Microsoft_Win32_TaskScheduler_Action_Clone.htm" />
17+
<HelpKINode Title="Action.CompareTo method" Url="html/M_Microsoft_Win32_TaskScheduler_Action_CompareTo.htm" />
1718
<HelpKINode Title="Action.CreateAction method" Url="html/M_Microsoft_Win32_TaskScheduler_Action_CreateAction.htm" />
1819
<HelpKINode Title="Action.Dispose method" Url="html/M_Microsoft_Win32_TaskScheduler_Action_Dispose.htm" />
1920
<HelpKINode Title="Action.Equals method" Url="html/Overload_Microsoft_Win32_TaskScheduler_Action_Equals.htm" />
@@ -279,7 +280,12 @@
279280
<HelpKINode Title="ComObjectSelectionDialog.ServerType property" Url="html/P_Microsoft_Win32_TaskScheduler_ComObjectSelectionDialog_ServerType.htm" />
280281
<HelpKINode Title="ComObjectSelectionDialog.SupportedInterface property" Url="html/P_Microsoft_Win32_TaskScheduler_ComObjectSelectionDialog_SupportedInterface.htm" />
281282
<HelpKINode Title="ComObjectSelectionDialog.SupportedServers enumeration" Url="html/T_Microsoft_Win32_TaskScheduler_ComObjectSelectionDialog_SupportedServers.htm" />
282-
<HelpKINode Title="CompareTo method" Url="html/M_Microsoft_Win32_TaskScheduler_TaskEvent_CompareTo.htm" />
283+
<HelpKINode Title="CompareTo method">
284+
<HelpKINode Title="Action.CompareTo Method " Url="html/M_Microsoft_Win32_TaskScheduler_Action_CompareTo.htm" />
285+
<HelpKINode Title="Task.CompareTo Method " Url="html/M_Microsoft_Win32_TaskScheduler_Task_CompareTo.htm" />
286+
<HelpKINode Title="TaskEvent.CompareTo Method " Url="html/M_Microsoft_Win32_TaskScheduler_TaskEvent_CompareTo.htm" />
287+
<HelpKINode Title="Trigger.CompareTo Method " Url="html/M_Microsoft_Win32_TaskScheduler_Trigger_CompareTo.htm" />
288+
</HelpKINode>
283289
<HelpKINode Title="CompatDirectoryMonitorFailed enumeration member" Url="html/T_Microsoft_Win32_TaskScheduler_StandardTaskEventId.htm" />
284290
<HelpKINode Title="Compatibility property" Url="html/P_Microsoft_Win32_TaskScheduler_TaskSettings_Compatibility.htm" />
285291
<HelpKINode Title="CompatibilityLevel property" Url="html/P_Microsoft_Win32_TaskScheduler_TaskCompatibilityEntry_CompatibilityLevel.htm" />
@@ -2147,6 +2153,7 @@
21472153
<HelpKINode Title="TaskRunTimesDialog.Task Property " Url="html/P_Microsoft_Win32_TaskScheduler_TaskRunTimesDialog_Task.htm" />
21482154
<HelpKINode Title="TaskSchedulerWizard.Task Property " Url="html/P_Microsoft_Win32_TaskScheduler_TaskSchedulerWizard_Task.htm" />
21492155
</HelpKINode>
2156+
<HelpKINode Title="Task.CompareTo method" Url="html/M_Microsoft_Win32_TaskScheduler_Task_CompareTo.htm" />
21502157
<HelpKINode Title="Task.Definition property" Url="html/P_Microsoft_Win32_TaskScheduler_Task_Definition.htm" />
21512158
<HelpKINode Title="Task.Dispose method" Url="html/M_Microsoft_Win32_TaskScheduler_Task_Dispose.htm" />
21522159
<HelpKINode Title="Task.Enabled property" Url="html/P_Microsoft_Win32_TaskScheduler_Task_Enabled.htm" />
@@ -2953,6 +2960,7 @@
29532960
</HelpKINode>
29542961
<HelpKINode Title="Trigger.CheckBindValue method" Url="html/M_Microsoft_Win32_TaskScheduler_Trigger_CheckBindValue.htm" />
29552962
<HelpKINode Title="Trigger.Clone method" Url="html/M_Microsoft_Win32_TaskScheduler_Trigger_Clone.htm" />
2963+
<HelpKINode Title="Trigger.CompareTo method" Url="html/M_Microsoft_Win32_TaskScheduler_Trigger_CompareTo.htm" />
29562964
<HelpKINode Title="Trigger.CopyProperties method" Url="html/M_Microsoft_Win32_TaskScheduler_Trigger_CopyProperties.htm" />
29572965
<HelpKINode Title="Trigger.CreateTrigger method" Url="html/M_Microsoft_Win32_TaskScheduler_Trigger_CreateTrigger.htm" />
29582966
<HelpKINode Title="Trigger.Dispose method" Url="html/M_Microsoft_Win32_TaskScheduler_Trigger_Dispose.htm" />

0 commit comments

Comments
 (0)