Helper Members
Include Protected Members
Include Inherited Members
Provides functionality to declarative, code-free, rules-based workflow editors such as Microsoft SharePoint Designer.
The Helper type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Helper | Initializes a new instance of the Helper class. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Static member") |
AsDNBoolean | Attempts to coerce a Boolean value from the specified object and workflow instance. |
|
AsDNDateTime | Attempts to coerce a DateTime object from the specified object and workflow instance. |
|
AsDNDouble | Attempts to coerce a Double from the specified object and workflow instance. |
|
AsDNInt32 | Attempts to coerce an Int32 from the specified object and workflow instance. |
|
AsDNSPItemKey | Attempts to coerce a SPItemKey from the specified object and workflow instance. |
|
AsDNString | Attempts to coerce a String from the specified object and workflow instance. |
|
AsSPItemKeyExceptNullNoConvert | Attempts to coerce an SPItemKey object from a given object and workflow instance. |
|
CheckPermission(WorkflowContext, String, SPItemKey, ArrayList, ArrayList, String, SPItemKey) | Checks for valid permissions on specific list or list items during the execution of the specified workflow instance. |
|
CheckPermission(WorkflowContext, String, Int32, ArrayList, ArrayList, String, Int32) | Checks for valid permissions on specific list or list items during the execution of the specified workflow instance. |
|
CheckPermission(WorkflowContext, Guid, SPItemKey, ArrayList, ArrayList, Guid, SPItemKey, Boolean) | Checks for valid permissions on a specific list or list item during the execution of the specified workflow instance. |
|
CheckPermission(WorkflowContext, Guid, Int32, ArrayList, ArrayList, Guid, Int32, Boolean) | Checks for valid permissions on specific list or list items during the execution of the specified workflow instance. |
|
CheckPermissionExact(WorkflowContext, String, SPItemKey, ArrayList, ArrayList, String, SPItemKey) | Checks for specific user permissions for a specific list or list items during the execution of the specified workflow instance. |
|
CheckPermissionExact(WorkflowContext, String, Int32, ArrayList, ArrayList, String, Int32) | Checks for specific user permissions for a specific list or list items during the execution of the specified workflow instance. |
|
Compare(String, Object, Object) | Compares two objects by using a string that represents an evaluation operator and the WorkflowContext, in order to retrieve properties from the active workflow instance. |
|
Compare(WorkflowContext, String, Object, Object) | Compares two objects by using a string that represents an evaluation operator and the WorkflowContext, in order to retrieve properties from the active workflow instance. |
|
CreatedBy(WorkflowContext, String, SPItemKey, String) | Retrieves the name of the creator of a list item and compares it to a specified name. If the values match the method returns true. |
|
CreatedBy(WorkflowContext, String, Int32, String) | Finds the creator of the specified SharePoint Foundation list item and compares it to a specified name. |
|
CreatedInRange(WorkflowContext, String, SPItemKey, DateTime, DateTime) | Checks whether a specified list item was created within a specific date range. |
|
CreatedInRange(WorkflowContext, String, Int32, DateTime, DateTime) | Retrieves a list of SharePoint Foundation list items that are created within a range of specified dates. |
|
CurrentCulture | Returns the relevant culture information of a specific workflow instance. |
|
CurrentDate() | Retrieves the current system date and time. |
|
CurrentDate(WorkflowContext, Guid, SPItemKey) | Retrieves the current date of a specified list item. |
|
CurrentDate(WorkflowContext, Guid, Int32) | Retrieves the current system date of a specified SharePoint Foundation list item. |
|
CurrentDate(WorkflowContext, String, SPItemKey) | Retrieves the current date of a specified list item. |
|
CurrentDate(WorkflowContext, String, Int32) | Retrieves the current system date of a specified SharePoint Foundation list item either by its GUID or display name. |
|
CurrentUICulture | Retrieves culture information about the specified workflow instance. |
|
CustomLookupBool(WorkflowContext, String, SPItemKey, String) | Retrieves a Boolean value from a specified field in a list or list item. |
|
CustomLookupBool(WorkflowContext, String, Int32, String) | Retrieves the Boolean value of a field for a specified SharePoint Foundation list and list item. |
|
CustomLookupDateTime(WorkflowContext, String, SPItemKey, String) | Retrieves the DateTime value of a specified field. |
|
CustomLookupDateTime(WorkflowContext, String, Int32, String) | Retrieves the DateTime value of a field for a specified SharePoint Foundation list and list item. |
|
CustomLookupDouble(WorkflowContext, String, SPItemKey, String) | Retrieves the Double value of a specified field. |
|
CustomLookupDouble(WorkflowContext, String, Int32, String) | Retrieves the double value from a field for a specified SharePoint Foundation list and list item. |
|
CustomLookupFriendlyString(WorkflowContext, String, SPItemKey, String) | Retrieves a string value from a field for a specific list and list item. |
|
CustomLookupFriendlyString(WorkflowContext, String, Int32, String) | Retrieves a string value from a field for a specified SharePoint Foundationlist and list item. |
|
CustomLookupInt(WorkflowContext, String, SPItemKey, String) | Retrieves a Int32 value from a field for a specific list and list item. |
|
CustomLookupInt(WorkflowContext, String, Int32, String) | Retrieves an integer value from a field for a specified SharePoint Foundation list item. |
|
CustomLookupString(WorkflowContext, String, SPItemKey, String) | Retrieves a String value from a field for a specific list and list item. |
|
CustomLookupString(WorkflowContext, String, Int32, String) | Retrieves a string value from a field for a specified SharePoint Foundation list and list item. |
|
CustomLookupUser(WorkflowContext, String, SPItemKey, String) | Retrieves the user login value from a specified field and list. |
|
CustomLookupUser(WorkflowContext, String, Int32, String) | Retrieves a user logon value for a specified SharePoint Foundation list item from a specified field. |
|
DateTimeToDoubleAsSecondsExceptNull | Attempts to coerce a DateTime value into a Double object representing the seconds portion of the DateTime object. |
|
DateTimeToInt32AsSecondsExceptNull | Attempts to coerce a Datetime object into a Int32 value. |
|
DateTimeToSecondsDouble | Attempts to coerce a DateTime value into a Double object representing the seconds portion of the DateTime object. |
|
DateTimeToSecondsInt32 | Converts the specified time instance to a value that represents the number of seconds since midnight 1/1/1900. |
|
DateTimeToStringISO | Converts the specified instant in time to its equivalent string representation using the ISO 8601 format (yyyy-mm-ddThh:mm:ssZ). |
|
DateTimeToStringLongDate | Converts the specified time instance value to a long date value. |
|
DateTimeToStringLongTime | Converts the specified time instance to a long time pattern value. |
|
DateTimeToStringShortDate | Converts the specified time instance to a short date value. |
|
DateTimeToStringShortTime | Converts the specified the instant in time to a short time value. |
|
DisplayNameAsText | Retrieves and returns the display name of a user based on the specified user login name. |
|
DoubleToDateTimeAsSecondsExceptNull | Converts a value into an instant in time. |
|
DynamicString(Activity, String) | Produces a string from the input string based on a workflow activity. |
|
DynamicString(WorkflowContext, Activity, String) | Produces a string from the input string, based on a workflow context and workflow activity. |
|
DynamicStringForCondition | Produces a string from the input string based on a workflow context. |
|
DynamicStringForXml | Converts the specified dynamic string to a string in XML format. |
|
EmailAddressAsText | Retrieves and returns the email of a user address based on the specified user login name. |
|
Equals | (Inherited from Object.) |
|
ExceptionDoesNotDisableWorkflow | Determines whether the specified exception stops the workflow but does not prohibit it from running again. |
|
FileExistInWeb | Verifies whether a specified file exists in a specified SharePoint Foundation Web site. |
|
FileSizeIs(WorkflowContext, String, SPItemKey, Double, Double) | Verifies that a specified SharePoint Foundation list item is within a specified size range. |
|
FileSizeIs(WorkflowContext, String, Int32, Double, Double) | Verifies that a specified SharePoint Foundation list item is within a specified size range. |
|
FileTypeIs(WorkflowContext, String, SPItemKey, String) | Determines whether the specified document type name matches the value of the DocIcon field of the specified list item. |
|
FileTypeIs(WorkflowContext, String, Int32, String) | Checks the DocIcon field of a specified SharePoint Foundation list item for a specified document type. |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
Find(WorkflowContext, Guid, Int32, String, Guid, String) | Finds the field value of an external list that matches an associated field, list, and list item by using the GUID of the associated list identifier (ID). |
|
Find(WorkflowContext, String, Int32, String, String, String) | Finds the field value of an external list that matches an associated field, list, and list item, by using the list identifier (ID) or list name of the associated list. |
|
FindValue(WorkflowContext, Guid, String, Object) | Finds an item in a list that contains a field value that matches the specified value. |
|
FindValue(WorkflowContext, String, String, Object) | Finds an item in a list that contains a field value that matches the specified value. |
|
FindValueWithKey(WorkflowContext, Guid, String, Object) | Gets the item in the specified list that contains the specified field value. |
|
FindValueWithKey(WorkflowContext, String, String, Object) | Gets the item in the specified list that contains the specified field value. |
|
FindWithKey(WorkflowContext, Guid, SPItemKey, String, Guid, String) | Gets the item in the specified list based on the value of the field for the item in the associated list. |
|
FindWithKey(WorkflowContext, String, SPItemKey, String, String, String) | Gets the item in the specified list based on the value of the field for the item in the associated list. |
|
FormattedCurrency | Converts a value to a currency value. |
|
GetArrayList | Creates a dynamic array with the specified array elements. |
|
GetDefaultContentTypeId | Retrieves the default content type ID for a list. |
|
GetFieldDisplayName | Retrieves the display name value from a specified field. |
|
GetHashCode | (Inherited from Object.) |
|
GetListGuid | Retrieves a list GUID from a specified list name or list identifier (ID). |
|
GetType | (Inherited from Object.) |
|
GetUserId | Gets the ID of the user with the specified user login name. |
|
HTLookupBool | Gets the value of the specified field in the specified hash table. |
|
HTLookupDateTime | Gets the instant in time value of the specified field in the specified hash table. |
|
HTLookupDouble | Gets the double-precision 64-bit floating-point value of the specified field in the specified hash table. |
|
HTLookupFriendlyString | Gets the string value of the specified field in the specified hash table. |
|
HTLookupInt | Gets the integer value of the specified field in the specified hash table. |
|
HTLookupString | Gets the value of the specified field in the specified hash table. |
|
HTLookupUser | Gets the login name of the user in the specified hash table. |
|
Int32ToDateTimeAsSecondsExceptNull | Converts an integer value into an instant in time. |
|
Int64ToDateTimeAsSecondsExceptNull | Converts an integer value into an instant in time. |
|
IsNotNullZeroEmptyFalse | Verifies whether the specified value is not null , zero, empty, or false. |
|
IsValidUser | Verifies whether the specified user is an SPUser. |
|
LoginNameAsText | Gets the user login name based on the specified user login name. |
|
LookupBool(WorkflowContext, Guid, SPItemKey, String) | Retrieves the Boolean value of a field for the specified item in the specified list. |
|
LookupBool(WorkflowContext, Guid, Int32, String) | Retrieves the Boolean value of a field for a specified SharePoint Foundation list item when the list item GUID is known. |
|
LookupBool(WorkflowContext, String, SPItemKey, String) | Retrieves the Boolean value of a field for the specified list item. |
|
LookupBool(WorkflowContext, String, Int32, String) | Retrieves the Boolean value of a field for a specified SharePoint Foundation list item when the list item GUID or list name is known. |
|
LookupColumnDataOnlyAsDateTime | Gets a local instant in time from the specified string. |
|
LookupColumnDataOnlyAsDouble | Gets a double-precision 64-bit floating-point value from the specified string. |
|
LookupColumnDataOnlyAsId | Gets a list item based on the specified string. |
|
LookupColumnDataOnlyAsInteger | Gets an integer value from the specified string. |
|
LookupColumnDataOnlyAsString | Gets a string value from the specified string. |
|
LookupDateTime(WorkflowContext, Guid, SPItemKey, String) | Retrieves the instant in time for a specified SharePoint Foundation list item when the list GUID and list item are known. |
|
LookupDateTime(WorkflowContext, Guid, Int32, String) | Retrieves the DateTime value of a field for a specified SharePoint Foundation list item when the list item GUID is known. |
|
LookupDateTime(WorkflowContext, String, SPItemKey, String) | Retrieves the instant in time of a field for a specified SharePoint Foundation list item. |
|
LookupDateTime(WorkflowContext, String, Int32, String) | Retrieves the DateTime value of a field for a specified SharePoint Foundation list item when the list item GUID is known. |
|
LookupDouble(WorkflowContext, Guid, SPItemKey, String) | Retrieves the value of a field for the specified SharePoint Foundation list item. |
|
LookupDouble(WorkflowContext, Guid, Int32, String) | Retrieves the double value from a field for a specified SharePoint Foundation list item when the list GUID is known. |
|
LookupDouble(WorkflowContext, String, SPItemKey, String) | Retrieves the value of a field for a specified SharePoint Foundation item in a specified list. |
|
LookupDouble(WorkflowContext, String, Int32, String) | Retrieves the double value for a specified SharePoint Foundation list item from a specified field when the list GUID or the list name is known. |
|
LookupFriendlyString(WorkflowContext, Guid, SPItemKey, String) | Retrieves the string value of a field for the specified list item. |
|
LookupFriendlyString(WorkflowContext, Guid, Int32, String) | Retrieves a string value from a field for a specified SharePoint Foundation list item when the list GUID is known. |
|
LookupFriendlyString(WorkflowContext, String, SPItemKey, String) | Retrieves the value of a field for the specified list item. |
|
LookupFriendlyString(WorkflowContext, String, Int32, String) | Retrieves a string value from a field for a specified SharePoint Foundation list item when the list GUID is known. |
|
LookupIdOnly | Gets a list item based on the specified string. |
|
LookupIdOnlyAsInteger | Gets the ID of a list item based on the specified lookup string. |
|
LookupInt(WorkflowContext, Guid, SPItemKey, String) | Retrieves the integer value of a field for the specified list item. |
|
LookupInt(WorkflowContext, Guid, Int32, String) | Retrieves an integer value from a field for a specified SharePoint Foundation list item when the list GUID is known. |
|
LookupInt(WorkflowContext, String, SPItemKey, String) | Retrieves the integer value of a field for the specified list item. |
|
LookupInt(WorkflowContext, String, Int32, String) | Retrieves an integer value from a field for a specified SharePoint Foundation list item when the list GUID or list name is known. |
|
LookupString(WorkflowContext, Guid, SPItemKey, String) | Retrieves the string value of a field for the specified list item. |
|
LookupString(WorkflowContext, Guid, Int32, String) | Retrieves a string value from a field for a specified SharePoint Foundation list item when the list GUID is known. |
|
LookupString(WorkflowContext, String, SPItemKey, String) | Retrieves the string value of a field for the specified list item. |
|
LookupString(WorkflowContext, String, Int32, String) | Retrieves a string value from a field for a specified SharePoint Foundation list item when the list GUID or list name is known. |
|
LookupUser(WorkflowContext, Guid, SPItemKey, String) | Retrieves the user login name for the specified list item. |
|
LookupUser(WorkflowContext, Guid, Int32, String) | Retrieves a user login name from a field for a specified SharePoint Foundation list item when the list GUID is known. |
|
LookupUser(WorkflowContext, String, SPItemKey, String) | Retrieves the user login name for the specified list item. |
|
LookupUser(WorkflowContext, String, Int32, String) | Retrieves a user login name from a field for a specified SharePoint Foundation list item when the list GUID or list name is known. |
|
MemberwiseClone | (Inherited from Object.) |
|
MinimumSharePointDate | Returns the minimum date and time that can be entered in Microsoft SharePoint Foundation. |
|
ModifiedBy(WorkflowContext, String, SPItemKey, String) | Verifies whether the specified user was the last person to modify the specified list item. |
|
ModifiedBy(WorkflowContext, String, Int32, String) | Verifies that a specific user was the last person to modify a list item. |
|
ModifiedInRange(WorkflowContext, String, SPItemKey, DateTime, DateTime) | Verifies whether the specified list item was modified within the specified date range. |
|
ModifiedInRange(WorkflowContext, String, Int32, DateTime, DateTime) | Verifies whether a SharePoint Foundation list item has been modified within a specified date range. |
|
MultiChoiceCommaSeperated | Extracts a multi-choice string from the specified string. |
|
MultiDisplayNameSemicolon | Gets a set of display names of the users from the specified formatted string. |
|
MultiEmailAddressSemicolon | Gets a set of email addresses of the users from the specified formatted string. |
|
MultiLoginNameSemicolon | Takes a collection of users and returns a string that is a concatenation of the users’ login names delimited by semicolons. |
|
MultiLookupColumnDataOnly | Gets the column data portions based on the specified lookup string. |
|
MultiLookupIdOnly | Gets the set of IDs based on the specified lookup string. |
|
MultiUserIDSemicolon | Gets a set of IDs of the users from the specified formatted string. |
|
NoteAsPlainText | Converts rich text to plain text. |
|
ProcessStringField | Retrieves a string that represents the value of a specified workflow variable. |
|
ResolveToDisplayName | Retrieves the display name of a user that is contained in a SharePoint Foundation user field. |
|
ResolveToEmailName | Retrieves an e-mail name or a list of e-mail names of all users associated with the SharePoint Foundation web object found in the WorkflowContext.Web property. |
|
ResolveToUserName | Retrieves the user name of a SharePoint Foundation user when the e-mail address is supplied. |
|
ResolveUserField | Returns the login name of the specified user, a delimited list of login names of the specified list of users, or the specified string if it does not resolve to a login name or names. |
|
ResolveUsernameOrNull | Ensures that the specified user login name or group name exists and returns it. |
|
SecondsDoubleToDateTime | Converts a double-precision 64-bit floating-point value to an instant in time. |
|
SecondsInt32ToDateTime | Converts an integer value to an instant in time. |
|
SecondsInt64ToDateTime | Converts an integer value to an instant in time. |
|
TestListItem(WorkflowContext, Guid, SPItemKey, String, String, Object) | Verifies whether the specified value matches the value of the field found in the specified list item of the specified list. |
|
TestListItem(WorkflowContext, Guid, Int32, String, String, Object) | Compares a SharePoint Foundation list item field value to a specified value when the list GUID is known. |
|
TestListItem(WorkflowContext, String, SPItemKey, String, String, Object) | Verifies whether the specified value matches the value of the field found in the specified list item of the specified list. |
|
TestListItem(WorkflowContext, String, Int32, String, String, Object) | Compares a SharePoint Foundation list item field value to a specified value when the list GUID or name is known. |
|
ToBooleanExceptNull | Converts a specified value into an equivalent Boolean value. |
|
ToDateTime | Converts a specified value into an equivalent DateTime value. |
|
ToDateTimeExceptNull | Attempts to coerce a value into a DateTime object. |
|
ToDouble | Converts a specified value into a double data type. |
|
ToDoubleExceptNull | Converts a specified the value into an equivalent Double value. |
|
ToInt32 | Converts a specified value into an equivalent Int32 value. |
|
ToInt32ExceptNull | Coerces an object into an Int32. |
|
ToSPItemKey | Coerces an object into an SPItemKey object. |
|
ToSPItemKeyExceptNull | Coerces an object into an SPItemKey object. |
|
ToString() | (Inherited from Object.) |
|
ToString(WorkflowContext, Object) | Converts a specified object into a string data type. |
|
ToStringExceptNull | Coerces an object into a String. |
|
URLAsDescriptionText | Extracts the description text from a URL/description key/value pair. |
|
URLAsURLText | Extracts the URL portion from a URL/description key/value pair. |
|
UseItemId | Coerces a Object to an SPItemKey using AsSPItemKeyExceptNullNoConvert(WorkflowContext, Object) which retrieves an SPItemKey object and then returns the Id property of the result. |
|
UseItemKey | Coerces a Object to an SPItemKey using AsSPItemKeyExceptNullNoConvert(WorkflowContext, Object). |
|
UserIDAsInteger | Returns the user ID when provided user’s login name. |
|
UserIDAsNumber | Returns the user ID as a Double when provided the user’s login name. |
|
UserIDAsText | Returns the user ID as a String when provided the user’s login name. |
|
WILookupBool(WorkflowContext, String) | Looks up and returns the value of the specified Boolean field and workflow. The Boolean fields available are AllowDefaultContentApproval, AllowManual, AutoStartChange, AutoStartCreate, and PermissionsManual. |
|
WILookupBool(WorkflowContext, String, SPItemKey, String) | Looks up and returns the value of the specified Boolean field and workflow. The Boolean fields available are AllowDefaultContentApproval, AllowManual, AutoStartChange, AutoStartCreate, and PermissionsManual. |
|
WILookupBool(WorkflowContext, String, Int32, String) | Looks up and returns the value of the specified Boolean field and workflow. The Boolean fields available are AllowDefaultContentApproval, AllowManual, AutoStartChange, AutoStartCreate, and PermissionsManual. |
|
WILookupDateTime(WorkflowContext, String) | Looks up and returns a DateTime object from the specified field in the given workflow context. |
|
WILookupDateTime(WorkflowContext, String, SPItemKey, String) | Looks up and returns a DateTime object from the specified SPItemKey field in the given workflow context. |
|
WILookupDateTime(WorkflowContext, String, Int32, String) | Looks up and returns a DateTime object from the specified field in the given workflow context. |
|
WILookupFriendlyString(WorkflowContext, String) | Looks up the specified field in the given workflow context and returns a String containing the value of the field. |
|
WILookupFriendlyString(WorkflowContext, String, SPItemKey, String) | Looks up the specified field in the given workflow context and returns a String containing the value of the field based on the exclusions specified. |
|
WILookupFriendlyString(WorkflowContext, String, Int32, String) | Looks up the value of the specified field and workflow context. Results are filtered based on the values specified in ignorestr and ignoreint. |
|
WILookupString(WorkflowContext, String) | Looks up the specified field in the given workflow context object and returns it if it is a String. Otherwise, it returns the result of the ToString() method. |
|
WILookupString(WorkflowContext, String, SPItemKey, String) | Looks up the specified field in the given workflow context object and returns it if it is a String. Otherwise, it returns the result of the ToString() method. The results exclude what is specified in the ignorestr and ignoreitemkey parameters. |
|
WILookupString(WorkflowContext, String, Int32, String) | Looks up the specified field in the given workflow context object and returns it if it is a String. Otherwise, it returns the result of the ToString() method. The results exclude what is specified in the ignorestr and ignoreitemkey parameters. |
|
WILookupUser(WorkflowContext, String) | Looks up and returns the value of the specified user field in the given workflow context. |
|
WILookupUser(WorkflowContext, String, SPItemKey, String) | Looks up and returns the value of the specified user field in the given workflow context. The results are filtered by the exclusions specified in ignorestr and ignoreitemkey. |
|
WILookupUser(WorkflowContext, String, Int32, String) | Looks up and returns the value of the specified user field in the given workflow context. The results are filtered by the exclusions specified in ignorestr and ignoreint. |
|
WordsInTitle(WorkflowContext, String, SPItemKey, String) | Verifies that a word or words are included in the title of the specified list item. |
|
WordsInTitle(WorkflowContext, String, Int32, String) | Verifies that a word or words are included in the title of a specified SharePoint Foundation list item. |
Top