DocumentBase.GetWorkflowTasks Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns the workflow tasks that are assigned to the document.
public:
Microsoft::Office::Core::WorkflowTasks ^ GetWorkflowTasks();
public Microsoft.Office.Core.WorkflowTasks GetWorkflowTasks ();
member this.GetWorkflowTasks : unit -> Microsoft.Office.Core.WorkflowTasks
Public Function GetWorkflowTasks () As WorkflowTasks
Returns
A WorkflowTasks collection that contains the workflow tasks that are assigned to the document.
Examples
The following code example displays the number of workflow tasks that are currently associated with the document. The example then iterates through each workflow task, if any, and shows some selected task properties in a message box.
To add workflow tasks to your document, you must publish the document to an Office Sharepoint Server site. To use this example, run it from the ThisDocument
class in a document-level project.
private void DisplayWorkflowTasks()
{
Office.WorkflowTasks tasks = this.GetWorkflowTasks();
if (tasks.Count > 1)
{
MessageBox.Show("There are " + tasks.Count.ToString()
+ " workflow tasks.");
}
else if (tasks.Count == 1)
{
MessageBox.Show("There is " + tasks.Count.ToString()
+ " workflow task.");
}
else if (tasks.Count == 0)
{
MessageBox.Show(
"No workflow tasks are associated with this document.");
}
foreach (Office.WorkflowTask task in tasks)
{
MessageBox.Show(
"Workflow Task ID: " + task.Id
+ "\r\nWorkflow Task Name: " + task.Name
+ "\r\nAssigned To: " + task.AssignedTo
+ "\r\nDescription: " + task.Description);
}
}
Private Sub DisplayWorkflowTasks()
Dim tasks As Office.WorkflowTasks = Me.GetWorkflowTasks()
If tasks.Count > 1 Then
MessageBox.Show("There are " + tasks.Count.ToString() _
+ " workflow tasks.")
ElseIf tasks.Count = 1 Then
MessageBox.Show("There is " + tasks.Count.ToString() _
+ " workflow task.")
ElseIf tasks.Count = 0 Then
MessageBox.Show( _
"No workflow tasks are associated with this document.")
End If
For Each task As Office.WorkflowTask In tasks
MessageBox.Show( _
"Workflow Task ID: " + task.Id _
+ vbCrLf + "Workflow Task Name: " + task.Name _
+ vbCrLf + "Assigned To: " + task.AssignedTo _
+ vbCrLf + "Description: " + task.Description)
Next
End Sub