State Class |
Represents one possible state of a content-type's items.
Content-types can have multiple states, and when these are linked by transitions, this becomes a workflow.
Inheritance HierarchySystemObject
Packflow.ModelingModelingObject
Packflow.ModelingModelingObject_Extended
Packflow.ModelingState
Packflow.ModelingModelingObject
Packflow.ModelingModelingObject_Extended
Packflow.ModelingState
Namespace: Packflow.Modeling
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
SyntaxC#
public class State : ModelingObject_Extended, IState
The State type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | AutoStartTask |
Gets or sets a value indicating whether a task should be automatically started
when the user opens the item's form.
|
| BackColor |
Gets or sets the back color of the shape in the workflow schema.
This is an helper property, the source value is BackColoration.
|
| CanDoIds |
Gets or sets the list of "Can do" activities' ids.
|
| CanDos |
Gets or sets the list of "Can do" activities.
|
| Coloration |
Gets or sets the back color (of the shape in the workflow schema) as text (ARGB format).
|
| ConfirmFinishTask |
Gets or sets a value indicating whether a confirmation dialog is shown
when the user tries to finish his task.
|
| DefaultSection |
Gets or sets the default section.
When this state is the current state of an item, the form will open
with the default section directly shown (selecting the corresponding tag or by a default scroll).
|
| DefaultSectionId |
Gets or sets the default section's id.
When this state is the current state of an item, the form will open
with the default section directly shown (selecting the corresponding tag or by a default scroll).
|
| Description |
Gets or sets the description.
|
| DescriptionRes |
Gets or sets the resource containing translations for the Description property.
|
| DisplayName |
Gets or sets the display name.
|
| DisplayNameRes |
Gets or sets the resource containing translations for the DisplayName property.
|
| EnableTasks |
Gets or sets a value indicating whether tasks can be created when an item is in this state.
Tasks are assigned to the users having the privilege "Responsible" for this particular state.
|
| FontColor |
Gets or sets the font color of the shape in the workflow schema.
This is an helper property, the source value is FontColoration.
|
| FontColoration |
Gets or sets the font color (of the shape in the workflow schema) as text (ARGB format).
|
| Guid |
Gets the GUID identifying this object.
(Inherited from ModelingObject.) |
| Height |
Gets or sets the height of the workflow shape.
Default value: 70.
|
| Id |
Gets the id identifying this object.
(Inherited from ModelingObject.) |
| InstanceGuid |
Gets a guid, unique for this object instance.
(Inherited from ModelingObject.) |
| InstanceLanguage |
Gets or sets the instance language (two letters format).
(Inherited from ModelingObject.) |
| IsExtended |
Gets a value indicating whether this object is Extended (ModelingObject_Extended) or not,
allowing to avoid an "is" verification.
(Inherited from ModelingObject_Extended.) |
| MaxParticipationLevel |
Gets or sets the maximum participation level.
The nature of this level is determined by the MaxParticipationLevelType property.
If the maximum participation has been reached, the state instance of an item can be closed
even if some tasks have not been completed yet.
|
| MaxParticipationLevelType |
Gets or sets a value indicating how the maximum participation is calculated.
|
| MinParticipationLevel |
Gets or sets the minimum participation level.
The nature of this level is determined by the MinParticipationLevelType property.
The state instance of an item cannot be closed as long as the minimum participation has not been reached,
this means that enough tasks must have been accomplished before the workflow can proceed to the next step.
|
| MinParticipationLevelType |
Gets or sets a value indicating how the minimum participation is calculated.
|
| Model |
Gets the model hosting this object. The Model is the root object of the modeling tree.
(Inherited from ModelingObject.) |
| Name |
Gets the name of this object.
(Inherited from ModelingObject.) |
| OrderAndDisplayName |
Gets the display name prefixed with the order number, if any.
|
| OrderAndName |
Gets the name prefixed with the order number, if any.
|
| OrderNo |
Gets or sets the state order number. This value is optional.
Used in the composition of the OrderAndDisplayName property.
|
| OrderNoPrefix |
Gets the order no formatted as a name prefix, or an empty string if the order no is empty.
|
| Parent |
Gets the parent object in the modeling tree.
(Inherited from ModelingObject.) |
| ParentContentType |
Gets the parent content-type.
|
| ParentType |
Gets the type of the parent object in the modeling tree.
(Inherited from ModelingObject.) |
| ParticipantsFieldId |
Gets or sets the column's id of the field that will receive the current actors (having a task) as value.
|
| PosX |
Gets or sets the horizontal position in the workflow schema.
Default value: 50.
|
| PosY |
Gets or sets the vertical position in the workflow schema.
Default value: 50.
|
| ShowInPermissionGrid |
Gets or sets a value indicating whether this state should be shown in Packflow Designer
in the grid of content-type permissions.
This allows to setup permissions specific to this state.
|
| StartDateColumnId |
Gets or sets the column's id of the field that will receive the current date when
an instance of this state is closed on an item.
|
| Step |
Gets or sets the related step.
|
| StepId |
Gets or sets the related step's id.
|
| stringFont |
Gets or sets the text's font (of the shape in the workflow schema) as text.
|
| TasksDueDates |
Gets the due dates' definitions for the tasks created for this state.
|
| TextFont |
Gets or sets the text's font of the shape in the workflow schema.
This is an helper property, the source value is StringFont.
|
| ToDo |
Gets or sets the "To do" activity.
|
| ToDoId |
Gets or sets the "To do" activity's id.
|
| Transitions |
Gets the transitions. These transitions have this state as inbound state.
|
| Width |
Gets or sets the width of the workflow shape.
Default value: 150.
|
Methods| Name | Description | |
|---|---|---|
 | AddTasksDueDate |
Adds a new task due date.
|
| AddTransition |
Adds a new transition.
|
| Children |
Returns all children objects.
(Inherited from ModelingObject.) |
| DeleteTransition |
Deletes the specified transition.
|
| GetGuid |
Gets the Guid.
(Inherited from ModelingObject.) |
| GetListItem |
Gets a text representing this object using Id and Name.
(Inherited from ModelingObject.) |
| GetName |
Gets the name.
(Inherited from ModelingObject.) |
| GetParentParentType |
Returns the first parent of a given type in the modeling tree.
Returns null if not found.
(Inherited from ModelingObject.) |
| GetStateDisplayName |
Gets the state's display name.
|
| GetStateGuid |
Gets the state's GUID.
|
| GetStateName |
Gets the state's name.
|
| GetTransitionById |
Gets a transition by its id.
|
| IsMaxParticipationReached |
Determines whether the maximum participation has been reached.
If the maximum participation has been reached, the state instance of an item can be closed
even if some tasks have not been completed yet.
|
| IsMinParticipationReached |
Determines whether the minimum participation has been reached.
The state instance of an item cannot be closed as long as the minimum participation has not been reached,
this means that enough tasks must have been accomplished before the workflow can proceed to the next step.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsT |
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.) |
| EqualsAll |
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.) |
| EqualsAny |
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.) |
| GetString |
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.) |
| IsGenericList | Overloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.) |
| IsGenericList(Type) | Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.) |
| Serialize | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| Serialize(String) | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| SerializeJson | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(ListType) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(DataContractJsonSerializerSettings) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
See Also