String functions
Guid
Declaration
string Guid()Description
Creates GUID.
Supported Runtime Versions
5.0
Parameters
The function has no parameters.
Return Value
New string with GUID in the given format type: 465ce0d3-dd54-4fc8-bf9a-b65e43c256d4.
StringConcat
Declaration
string StringConcat(string s1, string s2)Description
Concatenates two strings.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s1 |
First string to be concatenated. |
s2 |
Second string to be concatenated. |
Return Value
Concatenation of s1 and s2.
StringContains
Declaration
bool StringContains(string s, string find)Description
Checks whether a given string contains another string.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
String to be checked. |
find |
String to look for. |
Return Value
True, if 'find' could be found in s, false otherwise.
StringEndsWith
Declaration
bool StringEndsWith(string s, string find)Description
Checks whether a given string ends with a certain string.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
String to be checked. |
find |
End string to be checked for. |
Return Value
True, if s ends with 'find', false otherwise.
StringFind
Declaration
int StringFind(string s, string find, int start)Description
Tries to find a substring in a string.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
The string to search in. |
find |
The string to be searched for. |
start |
The index in string s to start the search at. |
Return Value
The index of the 'find' string in s.
StringJoin
Declaration
string StringJoin(StringArray array, string delimiter)Description
Combines all elements of StringArray into a single string.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
array |
Array of strings to be combined. |
delimiter |
Delimiter used to separate the strings. |
Return Value
A single string containing all array elements separated by the delimiter.
StringJoin
Declaration
string StringJoin(StringList list, string delimiter)Description
Combines all elements of a StringList into a single string.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
list |
List of strings to be combined. |
delimiter |
Delimiter used to separate the strings. |
Return Value
A single string containing all list elements separated by the delimiter.
StringLeft
Declaration
string StringLeft(string s, int length)Description
Returns a string containing a specified number of characters from the left side of a string.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
String to return characters for. |
length |
Number of characters to be returned. |
Return Value
A string containing a specified number of characters from the left side of a string.
StringLength
Declaration
int StringLength(string s)Description
Calculates the length of a given string measured in characters.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
String to calculate length of. |
Return Value
Length of string s measured in characters.
StringMatchesRegex
Declaration
bool StringMatchesRegex(string s, string regex)Description
Checks whether a string matches a certain regular expression.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
The string to be checked. |
regex |
The regular expression to look for. |
Return Value
True, if the string matches the regular expression, false otherwise.
StringReplace
Declaration
string StringReplace(string s, string find, string replace, bool onlyFirst)Description
Replaces a substring in a given string with a new value. This function name is confusing as it works the same way as StringReplaceRegex(). For clarity, it was marked as obsolete. Please use StringReplaceRegex() or StringReplaceDirect() instead.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
The string to be modified. |
find |
The substring to be replaced. |
replace |
The replacement for the substring. |
onlyFirst |
If true, only the first occurrence will be replaced. Otherwise, all occurrences will be replaced. |
Return Value
The string including the replaced part.
StringReplaceDirect
Declaration
string StringReplaceDirect(string s, string oldValue, string newValue)Description
Replaces a substring in a given string with a new value.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
s |
The string to be modified. |
oldValue |
The substring to be replaced. |
newValue |
The replacement for the substring. |
Return Value
The string including the replaced part.
StringReplaceDirect
Declaration
string StringReplaceDirect(string s, StringList oldValues, string newValue)Description
Replaces a list of substrings in a given string with a new value.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
s |
The string to be modified. |
oldValues |
The substrings (StringList) to be replaced. |
newValue |
The replacement for the substrings. |
Return Value
The string including the replaced part.
StringReplaceRegex
Declaration
string StringReplaceRegex(string s, string regex, string replace, bool onlyFirst)Description
Replaces one or all occurrences of a regular expression in a string with a replacement string.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
The string to be modified. |
regex |
The regular expression to look for. |
replace |
The replacement string. |
onlyFirst |
If true, only the first match of the regular expression will be replaced. |
Return Value
The modified string.
StringRight
Declaration
string StringRight(string s, int length)Description
Returns a string containing a specified number of characters from the right side of a string.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
String to return characters for. |
length |
Number of characters to be returned. |
Return Value
A string containing a specified number of characters from the right side of a string.
StringSplit
Declaration
StringArray StringSplit(string s, string delimiter)Description
Splits a string at a delimiter character and returns its parts as a StringArray.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
The string to be split. |
delimiter |
The delimiter to split at. |
Return Value
A StringArray containing the separate parts of the string.
StringSplit
Declaration
StringArray StringSplit(string s, string delimiter, int count)Description
Splits a string at a delimiter character and returns its parts as a StringArray.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
The string to be split. |
delimiter |
The delimiter to split at. |
count |
The maximum number of elements to be returned. |
Return Value
A StringArray containing the separate parts of the string.
StringSplitRegex
Declaration
StringArray StringSplitRegex(string s, string regex)Description
Splits a string at a regular expression and returns its parts as a StringArray.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
The string to be split. |
regex |
A regular expression to split at. |
Return Value
A StringArray containing the separate parts of the string.
StringStartsWith
Declaration
bool StringStartsWith(string s, string find)Description
Checks whether a given string starts with a certain string.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
String to be checked. |
find |
Start string to be checked for. |
Return Value
True, if s starts with 'find', false otherwise.
StringSubstring
Declaration
string StringSubstring(string s, int startIndex, int length)Description
Returns a substring contained in a string.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
String from which a substring is to be received. |
startIndex |
Start index (starting at 0) of the substring. |
length |
Length of the substring. |
Return Value
Substring having length 'length' and starting at index 'startIndex'.
StringTrim
Declaration
string StringTrim(string s)Description
Trims all leading and trailing white spaces from a string.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
String to be trimmed. |
Return Value
The trimmed string.
StringTrimEnd
Declaration
string StringTrimEnd(string s)Description
Trims all leading white spaces from a string.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
String to be trimmed. |
Return Value
The trimmed string.
StringTrimStart
Declaration
string StringTrimStart(string s)Description
Trims all trailing white spaces from a string.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
String to be trimmed. |
Return Value
The trimmed string.
ToActivityStatus
Declaration
ActivityStatus ToActivityStatus(string value)Description
Parses ActivityStatus enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
ActivityStatus enum instance. |
Return Value
The string value of ActivityStatus.
ToApplicationPermission
Declaration
ApplicationPermission ToApplicationPermission(string value)Description
Converts ApplicationPermission enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
ApplicationPermission enum instance. |
Return Value
The string value of ApplicationPermission.
ToAsyncExecutionFlags
Declaration
AsyncExecutionFlags ToAsyncExecutionFlags(string value)Description
Parses AsyncExecutionFlags enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to AsyncExecutionFlags. |
Return Value
Instance of AsyncExecutionFlags enum.
ToAsyncOperationStatus
Declaration
AsyncOperationStatus ToAsyncOperationStatus(string value)Description
Parses AsyncOperationStatus enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to AsyncOperationStatus. |
Return Value
Instance of AsyncOperationStatus enum.
ToAsyncOperationType
Declaration
AsyncOperationType ToAsyncOperationType(string value)Description
Parses AsyncOperationType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to AsyncOperationType. |
Return Value
Instance of AsyncOperationType enum.
ToAuthenticationSystem
Declaration
AuthenticationSystem ToAuthenticationSystem(string value)Description
Converts AuthenticationSystem enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
AuthenticationSystem enum instance. |
Return Value
The string value of AuthenticationSystem.
ToBase64String
Declaration
string ToBase64String(BinaryData data)Description
Attempts to convert binary data to a base64 string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
data |
Binary data to convert. |
Return Value
Converted text.
ToBookExportDocumentType
Declaration
BookExportDocumentType ToBookExportDocumentType(string value)Description
Parses BookExportDocumentType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to BookExportDocumentType. |
Return Value
Instance of BookExportDocumentType enum.
ToBookExportImageType
Declaration
BookExportImageType ToBookExportImageType(string value)Description
Parses BookExportImageType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to BookExportImageType. |
Return Value
Instance of BookExportImageType enum.
ToBookExportOutputType
Declaration
BookExportOutputType ToBookExportOutputType(string value)Description
Parses BookExportOutputType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to BookExportOutputType. |
Return Value
Instance of BookExportOutputType enum.
ToBookExportProfileType
Declaration
BookExportProfileType ToBookExportProfileType(string value)Description
Parses BookExportProfileType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to BookExportProfileType. |
Return Value
Instance of BookExportProfileType enum.
ToBookExportSelectionMode
Declaration
BookExportSelectionMode ToBookExportSelectionMode(string value)Description
Parses BookExportSelectionMode enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to BookExportSelectionMode. |
Return Value
Instance of BookExportSelectionMode enum.
ToBookExportSelectionType
Declaration
BookExportSelectionType ToBookExportSelectionType(string value)Description
Parses BookExportSelectionType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to BookExportSelectionType. |
Return Value
Instance of BookExportSelectionType enum.
ToBool
Declaration
bool ToBool(string value)Description
Converts a string into a bool value.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
The string to be converted into a bool. |
Return Value
Bool representation of value.
ToBusinessObjectType
Declaration
BusinessObjectType ToBusinessObjectType(string value)Description
Parses BusinessObjectType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
BusinessObjectType enum instance. |
Return Value
The string value of BusinessObjectType.
ToDataPermission
Declaration
DataPermission ToDataPermission(string value)Description
Converts DataPermission enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
DataPermission enum instance. |
Return Value
The string value of DataPermission.
ToDouble
Declaration
double ToDouble(string value, string culture)Description
Converts a string into a double value using specific culture. The function raises an error if value is not numeric.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
The string to be converted into a double. |
culture |
The culture to be used. |
Return Value
Double representation of a value.
ToDouble
Declaration
double ToDouble(string value)Description
Converts a string into a double value. The function raises an error if value is not numeric.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
value |
The string to be converted into a double. |
Return Value
Double representation of a value.
ToEntityActivity
Declaration
EntityActivity ToEntityActivity(string value)Description
Parses EntityActivity enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
EntityActivity enum instance. |
Return Value
The string value of EntityActivity.
ToGlobalActivity
Declaration
GlobalActivity ToGlobalActivity(string value)Description
Parses GlobalActivity enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
GlobalActivity enum instance. |
Return Value
The string value of GlobalActivity.
ToGroupActivity
Declaration
GroupActivity ToGroupActivity(string value)Description
Parses GroupActivity enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
GroupActivity enum instance. |
Return Value
The string value of GroupActivity.
ToGroupProperty
Declaration
GroupProperty ToGroupProperty(string value)Description
Converts GroupProperty enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
GroupProperty enum instance. |
Return Value
The string value of GroupProperty.
ToInt
Declaration
int ToInt(double x)Description
Converts a double value to an int type.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
x |
The double value to be converted. |
Return Value
Value x converted to an int type.
ToInt
Declaration
int ToInt(string value)Description
Converts a string into an int. The function raises an error if value is not numeric.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
value |
The string to be converted into an int. |
Return Value
Int representation of value.
ToIntegrationDataImportType
Declaration
IntegrationDataImportType ToIntegrationDataImportType(string value)Description
Parses IntegrationDataImportType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
IntegrationDataImportType enum instance. |
Return Value
The string value of IntegrationDataImportType.
ToIntegrationImportType
Declaration
IntegrationImportType ToIntegrationImportType(string value)Description
Parses IntegrationImportType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
IntegrationImportType enum instance. |
Return Value
The string value of IntegrationImportType.
ToLower
Declaration
string ToLower(string s)Description
Turns all characters in a string into lowercase.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
The string to be converted. |
Return Value
New string containing only lowercase characters.
ToMinglePrivacyLevel
Declaration
MinglePrivacyLevel ToMinglePrivacyLevel(string value)Description
Parses MinglePrivacyLevel enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to MinglePrivacyLevel. |
Return Value
Instance of MinglePrivacyLevel enum.
ToOLAPCubeType
Declaration
OLAPCubeType ToOLAPCubeType(string value)Description
Parses OLAPCubeType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to OLAPCubeType. |
Return Value
Instance of OLAPCubeType enum.
ToOlapSplashCommandElementType
Declaration
OLAPSplashCommandElementType ToOlapSplashCommandElementType(string value)Description
Parses OlapSplashCommandElementType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
OlapSplashCommandElementType enum instance. |
Return Value
The string value of OlapSplashCommandElementType.
ToOlapSubsetAccess
Declaration
OlapSubsetAccess ToOlapSubsetAccess(string value)Description
Parses OlapSubsetAccess enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to OlapSubsetAccess. |
Return Value
Instance of OlapSubsetAccess enum.
ToProcessStatus
Declaration
ProcessStatus ToProcessStatus(string value)Description
Parses ProcessStatus enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to ProcessStatus. |
Return Value
Instance of ProcessStatus enum.
ToRequestMethodType
Declaration
RequestMethodType ToRequestMethodType(string value)Description
Parses RequestMethodType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
RequestMethodType enum instance. |
Return Value
The string value of RequestMethodType.
ToRequestParameterType
Declaration
RequestParameterType ToRequestParameterType(string value)Description
Parses RequestParameterType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
RequestParameterType enum instance. |
Return Value
The string value of RequestParameterType.
ToRoleProperty
Declaration
RoleProperty ToRoleProperty(string value)Description
Converts RoleProperty enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
RoleProperty enum instance. |
Return Value
The string value of RoleProperty.
ToRoleType
Declaration
RoleType ToRoleType(string value)Description
Converts RoleType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
RoleType enum instance. |
Return Value
The string value of RoleType.
ToSharedMediaType
Declaration
SharedMediaType ToSharedMediaType(string value)Description
Parses SharedMediaType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String value to be converted to SharedMediaType. |
Return Value
Instance of SharedMediaType enum.
ToSortOrder
Declaration
SortOrder ToSortOrder(string value)Description
Parses SortOrder enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SortOrder enum instance. |
Return Value
The string value of SortOrder.
ToSQLAlterIndexOp
Declaration
SQLAlterIndexOp ToSQLAlterIndexOp(string value)Description
Parses SQLAlterIndexOp enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SQLAlterIndexOp enum instance. |
Return Value
The string value of SQLAlterIndexOp.
ToSqlDataType
Declaration
SqlDataType ToSqlDataType(string value)Description
Parses SqlDataType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SqlDataType enum instance. |
Return Value
The string value of SqlDataType.
ToSQLIndexType
Declaration
SQLIndexType ToSQLIndexType(string value)Description
Parses SQLIndexType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SQLIndexType enum instance. |
Return Value
The string value of SQLIndexType.
ToSQLPreparedCommandType
Declaration
SQLPreparedCommandType ToSQLPreparedCommandType(string value)Description
Parses SQLPreparedCommandType enum from a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SQLPreparedCommandType enum instance. |
Return Value
The string value of SQLPreparedCommandType.
ToString
Declaration
string ToString(BinaryData data)Description
Attempts to convert binary data to text using UTF-8 encoding.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
data |
Binary data to convert. |
Return Value
Converted text.
ToString
Declaration
string ToString(BinaryData data, string encoding)Description
Attempts to convert binary data to text using specified encoding.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
data |
Binary data to convert. |
encoding |
Encoding for the conversion to binary data. |
Return Value
Converted text.
ToString
Declaration
string ToString(ProcessStatus value)Description
Converts ProcessStatus enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
ProcessStatus enum instance. |
Return Value
The string value of ProcessStatus.
ToString
Declaration
string ToString(AsyncOperationStatus value)Description
Converts the AsyncOperationStatus enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
AsyncOperationStatus enum instance. |
Return Value
The string value of AsyncOperationStatus.
ToString
Declaration
string ToString(AsyncExecutionFlags value)Description
Converts AsyncExecutionFlags enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
AsyncExecutionFlags enum instance. |
Return Value
The string value of AsyncExecutionFlags.
ToString
Declaration
string ToString(MinglePrivacyLevel value)Description
Converts MinglePrivacyLevel enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
MinglePrivacyLevel enum instance. |
Return Value
The string value of MinglePrivacyLevel.
ToString
Declaration
string ToString(OlapSubsetAccess value)Description
Converts OlapSubsetAccess enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
OlapSubsetAccess enum instance. |
Return Value
The string value of OlapSubsetAccess.
ToString
Declaration
string ToString(SqlDataType value)Description
Converts SqlDataType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SqlDataType enum instance. |
Return Value
The string value of SqlDataType.
ToString
Declaration
string ToString(SQLPreparedCommandType value)Description
Converts SQLPreparedCommandType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SQLPreparedCommandType enum instance. |
Return Value
The string value of SQLPreparedCommandType.
ToString
Declaration
string ToString(SQLIndexType value)Description
Converts SQLIndexType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SQLIndexType enum instance. |
Return Value
The string value of SQLIndexType.
ToString
Declaration
string ToString(SQLAlterIndexOp value)Description
Converts SQLAlterIndexOp enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SQLAlterIndexOp enum instance. |
Return Value
The string value of SQLAlterIndexOp.
ToString
Declaration
string ToString(SortOrder value)Description
Converts SortOrder enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SortOrder enum instance. |
Return Value
The string value of SortOrder.
ToString
Declaration
string ToString(RequestMethodType value)Description
Converts RequestMethodType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
RequestMethodType enum instance. |
Return Value
The string value of RequestMethodType.
ToString
Declaration
string ToString(RequestParameterType value)Description
Converts RequestParameterType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
RequestParameterType enum instance. |
Return Value
The string value of RequestParameterType.
ToString
Declaration
string ToString(ActivityStatus value)Description
Converts ActivityStatus enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
ActivityStatus enum instance. |
Return Value
The string value of ActivityStatus.
ToString
Declaration
string ToString(BusinessObjectType value)Description
Converts BusinessObjectType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
BusinessObjectType enum instance. |
Return Value
The string value of BusinessObjectType.
ToString
Declaration
string ToString(EntityActivity value)Description
Converts EntityActivity enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
EntityActivity enum instance. |
Return Value
The string value of EntityActivity.
ToString
Declaration
string ToString(GlobalActivity value)Description
Converts GlobalActivity enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
GlobalActivity enum instance. |
Return Value
The string value of GlobalActivity.
ToString
Declaration
string ToString(GroupActivity value)Description
Converts GroupActivity enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
GroupActivity enum instance. |
Return Value
The string value of GroupActivity.
ToString
Declaration
string ToString(IntegrationDataImportType value)Description
Converts IntegrationDataImportType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
IntegrationDataImportType enum instance. |
Return Value
The string value of IntegrationDataImportType.
ToString
Declaration
string ToString(IntegrationImportType value)Description
Converts IntegrationImportType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
IntegrationImportType enum instance. |
Return Value
The string value of IntegrationImportType.
ToString
Declaration
string ToString(OLAPSplashCommandElementType value)Description
Converts OlapSplashCommandElementType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
OlapSplashCommandElementType enum instance. |
Return Value
The string value of OlapSplashCommandElementType.
ToString
Declaration
string ToString(AuthenticationSystem value)Description
Converts AuthenticationSystem enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
AuthenticationSystem enum instance. |
Return Value
The string value of AuthenticationSystem.
ToString
Declaration
string ToString(ApplicationPermission value)Description
Converts ApplicationPermission enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
ApplicationPermission enum instance. |
Return Value
The string value of ApplicationPermission.
ToString
Declaration
string ToString(DataPermission value)Description
Converts DataPermission enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
DataPermission enum instance. |
Return Value
The string value of DataPermission.
ToString
Declaration
string ToString(GroupProperty value)Description
Converts GroupProperty enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
GroupProperty enum instance. |
Return Value
The string value of GroupProperty.
ToString
Declaration
string ToString(RoleProperty value)Description
Converts RoleProperty enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
RoleProperty enum instance. |
Return Value
The string value of RoleProperty.
ToString
Declaration
string ToString(RoleType value)Description
Converts RoleType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
RoleType enum instance. |
Return Value
The string value of RoleType.
ToString
Declaration
string ToString(UserProperty value)Description
Converts UserProperty enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
UserProperty enum instance. |
Return Value
The string value of UserProperty.
ToString
Declaration
string ToString(SharedMediaType value)Description
Converts SharedMediaType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
SharedMediaType enum instance. |
Return Value
The string value of SharedMediaType.
ToString
Declaration
string ToString(BookExportOutputType value)Description
Converts BookExportOutputType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
BookExportOutputType enum instance. |
Return Value
The string value of BookExportOutputType.
ToString
Declaration
string ToString(BookExportImageType value)Description
Converts BookExportImageType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
BookExportImageType enum instance. |
Return Value
The string value of BookExportImageType.
ToString
Declaration
string ToString(BookExportSelectionMode value)Description
Converts BookExportSelectionMode enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
BookExportSelectionMode enum instance. |
Return Value
The string value of BookExportSelectionMode.
ToString
Declaration
string ToString(BookExportSelectionType value)Description
Converts BookExportSelectionType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
BookExportSelectionType enum instance. |
Return Value
The string value of BookExportSelectionType.
ToString
Declaration
string ToString(BookExportDocumentType value)Description
Converts BookExportDocumentType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
BookExportDocumentType enum instance. |
Return Value
The string value of BookExportDocumentType.
ToString
Declaration
string ToString(BookExportProfileType value)Description
Converts BookExportProfileType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
BookExportProfileType enum instance. |
Return Value
The string value of BookExportProfileType.
ToString
Declaration
string ToString(OLAPCubeType value)Description
Converts OLAPCubeType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
OLAPCubeType enum instance. |
Return Value
The string value of OLAPCubeType.
ToString
Declaration
string ToString(RuntimeSettings value)Description
Converts RuntimeSettings enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
RuntimeSettings enum instance. |
Return Value
The string value of RuntimeSettings.
ToString
Declaration
string ToString(AsyncOperationType value)Description
Converts AsyncOperationType enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
AsyncOperationType enum instance. |
Return Value
The string value of AsyncOperationType.
ToString
Declaration
string ToString(double value, string culture)Description
Converts a double value into a string, using specific culture.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
The double value to be converted into a string. |
culture |
The culture to be used. |
Return Value
The string representation of a value.
ToString
Declaration
string ToString(DateTime value)Description
Converts DateTime into a culture-invariant string representing the date time.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
Timestamp whose value should be converted into a string. |
Return Value
The value of the timestamp as a string.
ToString
Declaration
string ToString(DateTime value, string culture)Description
Converts DateTime into a string formatted according to the culture parameter.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
Timestamp whose value should be converted into a string. |
culture |
Culture to be used for formatting the date-time string. |
Return Value
The value of the timestamp as a string.
ToString
Declaration
string ToString(Variant value)Description
Converts Variant into a string. If the variant is null, an empty string is returned. To check if a variant is null, use is-statement.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
Variant whose value should be converted into a string. |
Return Value
The value of the variant as a string.
ToString
Declaration
string ToString(string value)Description
Converts a string into a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
String’s value which should be converted into a string. |
Return Value
The string without any changes.
ToString
Declaration
string ToString(XMLDocument document)Description
Returns a string representation of an XMLDocument.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
document |
The XMLDocument to be converted into a string. |
Return Value
A string representation of an XMLDocument.
ToString
Declaration
string ToString(XMLElement element)Description
Returns a string representation of an XMLElement.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
element |
The XMLElement to be converted into a string. |
Return Value
A string representation of an XMLElement.
ToString
Declaration
string ToString(bool value)Description
Converts a bool value into a string.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
value |
The bool value to be converted into a string. |
Return Value
The string representation of a value.
ToString
Declaration
string ToString(int value)Description
Converts an int value into a string.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
value |
The int value to be converted into a string. |
Return Value
The string representation of a value.
ToString
Declaration
string ToString(double value)Description
Converts a double value into a string.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
value |
The double value to be converted into a string. |
Return Value
The string representation of a value.
ToString
Declaration
string ToString(double value, string format, string culture)Description
Converts a double value into a string using specific format and culture.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
value |
The double value to be converted into a string. |
format |
The format to be used. |
culture |
The culture to be used. |
Return Value
The string representation of a value.
ToString
Declaration
string ToString(OLAPElement value)Description
Converts an OlapElement into a string representing the element name.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
value |
OlapElement value to be converted into a string. |
Return Value
The name of the OlapElement.
ToString
Declaration
string ToString(OLAPDimension value)Description
Converts an OlapDimension into a string representing the dimension name.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
value |
OlapDimension value to be converted into a string. |
Return Value
The name of the OlapDimension.
ToString
Declaration
string ToString(OLAPAttribute value)Description
Converts an OlapAttribute into a string representing the attribute name.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
value |
OlapAttribute value to be converted into a string. |
Return Value
The name of the OlapAttribute.
ToString
Declaration
string ToString(OLAPCell value)Description
Converts an OlapCell into a string representing the cell's value.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
value |
OlapCell whose value should be converted into a string. |
Return Value
The value of the OlapCell as a string.
ToUpper
Declaration
string ToUpper(string s)Description
Turns all characters in a string into uppercase.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters |
Description |
|---|---|
s |
The string to be converted. |
Return Value
New string containing only uppercase characters.
ToUserProperty
Declaration
UserProperty ToUserProperty(string value)Description
Converts UserProperty enum to a string.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
value |
UserProperty enum instance. |
Return Value
The string value of UserProperty.