Data types
This article was auto-generated by Genus Apps. Any modifications will be overwritten.
_2Months type
The _2Months type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | _2Months.fromCalendarTime(value) Return Type: _2Months value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| __2MonthsAndYearName | instance.__2MonthsAndYearName Return Type: String |
| endDate | instance.endDate Return Type: CalendarTime |
| id | instance.id Return Type: CalendarTime |
| periodType | instance.periodType Return Type: Integer |
| sequenceNumber | instance.sequenceNumber Return Type: Integer |
| yearNumber | instance.yearNumber Return Type: Integer |
_4Months type
The _4Months type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | _4Months.fromCalendarTime(value) Return Type: _4Months value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| __4MonthsAndYearName | instance.__4MonthsAndYearName Return Type: String |
| endDate | instance.endDate Return Type: CalendarTime |
| id | instance.id Return Type: CalendarTime |
| periodType | instance.periodType Return Type: Integer |
| sequenceNumber | instance.sequenceNumber Return Type: Integer |
| yearNumber | instance.yearNumber Return Type: Integer |
_4Weeks type
The _4Weeks type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | _4Weeks.fromCalendarTime(value) Return Type: _4Weeks value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| __4WeeksAndYearName | instance.__4WeeksAndYearName Return Type: String |
| endDate | instance.endDate Return Type: CalendarTime |
| id | instance.id Return Type: CalendarTime |
| periodType | instance.periodType Return Type: Integer |
| sequenceNumber | instance.sequenceNumber Return Type: Integer |
| yearNumber | instance.yearNumber Return Type: Integer |
Account type
The Account type exposes the following members.
Instance members
| Name | Description |
|---|---|
| accountProfile | instance.accountProfile Return Type: String |
| disabled | instance.disabled Return Type: Boolean |
| fullName | instance.fullName Return Type: String |
| language | instance.language Return Type: String |
| lastPasswordChange | instance.lastPasswordChange Return Type: CalendarTime |
| lockedOut | instance.lockedOut Return Type: Boolean |
| mailAddress | instance.mailAddress Return Type: String |
| securityGroupMemberships | instance.securityGroupMemberships Return Type: Bag(SecurityGroup) |
| userName | instance.userName Return Type: String |
ActionCommandType enumeration
The ActionCommandType enumeration exposes the following members.
| Name | Description |
|---|---|
| copy | ActionCommandType.copy |
| forward | ActionCommandType.forward |
| mailTo | ActionCommandType.mailTo |
| new | ActionCommandType.new |
| open | ActionCommandType.open |
| pasteSpecial | ActionCommandType.pasteSpecial |
| reply | ActionCommandType.reply |
| report | ActionCommandType.report |
| run | ActionCommandType.run |
| send | ActionCommandType.send |
ActionExceptionType enumeration
The ActionExceptionType enumeration exposes the following members.
| Name | Description |
|---|---|
| onApplicationNotInstalled | ActionExceptionType.onApplicationNotInstalled |
| onCardinalityViolation | ActionExceptionType.onCardinalityViolation |
| onConcurrencyError | ActionExceptionType.onConcurrencyError |
| onConsistencyCheckViolation | ActionExceptionType.onConsistencyCheckViolation |
| onCustomError | ActionExceptionType.onCustomError |
| onDataConstraintViolation | ActionExceptionType.onDataConstraintViolation |
| onDeleteConstraintViolation | ActionExceptionType.onDeleteConstraintViolation |
| onExecutionTimeout | ActionExceptionType.onExecutionTimeout |
| onExpressionEvaluationError | ActionExceptionType.onExpressionEvaluationError |
| onFileExists | ActionExceptionType.onFileExists |
| onFileNotFound | ActionExceptionType.onFileNotFound |
| onFileReadError | ActionExceptionType.onFileReadError |
| onFileRecordRejected | ActionExceptionType.onFileRecordRejected |
| onFileWriteError | ActionExceptionType.onFileWriteError |
| onHTTPCommunicationError | ActionExceptionType.onHTTPCommunicationError |
| onHTTPContentTypeMismatch | ActionExceptionType.onHTTPContentTypeMismatch |
| onInsufficientSecurityPermissions | ActionExceptionType.onInsufficientSecurityPermissions |
| onInvalidProgramExitCode | ActionExceptionType.onInvalidProgramExitCode |
| onInvalidSearch | ActionExceptionType.onInvalidSearch |
| onMailMergeError | ActionExceptionType.onMailMergeError |
| onModifyUserAccountError | ActionExceptionType.onModifyUserAccountError |
| onObjectsReadError | ActionExceptionType.onObjectsReadError |
| onPathNotFound | ActionExceptionType.onPathNotFound |
| onPrintError | ActionExceptionType.onPrintError |
| onProgramExecutionError | ActionExceptionType.onProgramExecutionError |
| onSendMailError | ActionExceptionType.onSendMailError |
| onTransactionCancelledByUser | ActionExceptionType.onTransactionCancelledByUser |
| onTransactionError | ActionExceptionType.onTransactionError |
| onTransactionTimeOut | ActionExceptionType.onTransactionTimeOut |
| onUniquenessConstraintViolation | ActionExceptionType.onUniquenessConstraintViolation |
| onWebServiceCommunicationError | ActionExceptionType.onWebServiceCommunicationError |
| onWebServiceEndpointNotFound | ActionExceptionType.onWebServiceEndpointNotFound |
| onWebServiceFault | ActionExceptionType.onWebServiceFault |
| onWebServiceMessageSecurityError | ActionExceptionType.onWebServiceMessageSecurityError |
ActionOrchestrator type
The ActionOrchestrator type exposes the following members.
Instance members
| Name | Description |
|---|---|
| command | instance.command Return Type: ActionCommandType |
| currentEnumeration | instance.currentEnumeration Return Type: Integer |
| currentTextSelection | instance.currentTextSelection Return Type: String |
| errorCode | instance.errorCode Return Type: Integer |
| errorDetails | instance.errorDetails Return Type: String |
| errorMessage | instance.errorMessage Return Type: String |
| lastReceivedHttpStatusCode | instance.lastReceivedHttpStatusCode Return Type: Integer |
| responseHttpStatusCode | instance.responseHttpStatusCode Return Type: HttpStatusCode |
| scheduledStartTime | instance.scheduledStartTime Return Type: CalendarTime |
| startTime | instance.startTime Return Type: CalendarTime |
| thrownExceptionCode | instance.thrownExceptionCode Return Type: ActionExceptionType |
| thrownExceptionName | instance.thrownExceptionName Return Type: String |
| totalNumberOfEnumerations | instance.totalNumberOfEnumerations Return Type: Integer |
AddressFormat enumeration
The AddressFormat enumeration exposes the following members.
| Name | Description |
|---|---|
| dOMINO | AddressFormat.dOMINO |
| eX | AddressFormat.eX |
| sMTP | AddressFormat.sMTP |
AuditTrailStep type
The AuditTrailStep type exposes the following members.
Instance members
| Name | Description |
|---|---|
| action | instance.action Return Type: String |
| identifier | instance.identifier Return Type: Guid |
Bag(<ElementType>) type
The Bag(<ElementType>) type exposes the following members.
Instance members
| Name | Description |
|---|---|
| asBag | instance.asBag Return Type: Bag(<ElementType>) |
| asOrderedSet | instance.asOrderedSet Return Type: OrderedSet(<ElementType>) |
| asSequence | instance.asSequence Return Type: Sequence(<ElementType>) |
| asSet | instance.asSet Return Type: Set(<ElementType>) |
| count | instance.count Return Type: Integer |
| count | instance.count(object) Return Type: Integer object - Type: <ElementType> |
| emptyIfNull | instance.emptyIfNull Returns the empty collection if the instance is null; otherwise, the instance is returned. Return Type: Bag(<ElementType>) |
| excludes | instance.excludes(object) Return Type: Boolean object - Type: <ElementType> |
| excludesAll | instance.excludesAll(c2) Return Type: Boolean c2 - Type: Collection(<ElementType>) |
| excluding | instance.excluding(object) Return Type: Bag(<ElementType>) object - Type: <ElementType> |
| exists | instance.exists(<iterator expression>) Returns TRUE if at least one Collection(<ElementType>) instance match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| flatten | instance.flatten Return Type: Bag(<ElementType>) |
| flattenRecursive | instance.flattenRecursive Return Type: Bag(<ElementType>) |
| forAll | instance.forAll(<iterator expression>) Returns TRUE if all Collection(<ElementType>) instances match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| includes | instance.includes(object) Return Type: Boolean object - Type: <ElementType> |
| includesAll | instance.includesAll(c2) Return Type: Boolean c2 - Type: Collection(<ElementType>) |
| including | instance.including(object) Return Type: Bag(<ElementType>) object - Type: <ElementType> |
| intersection | instance.intersection(b) Return Type: Bag(<ElementType>) b - Type: Bag(<ElementType>) |
| intersection | instance.intersection(s) Return Type: Set(<ElementType>) s - Type: Set(<ElementType>) |
| isEmpty | instance.isEmpty Return Type: Boolean |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Bag(<ElementType>) joinWith - Type: Collection(Object) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Bag(<ElementType>) joinWith - Type: Collection(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| notEmpty | instance.notEmpty Return Type: Boolean |
| reject | instance.reject(<iterator expression>) Removes all instances of <ElementType> that match the <iterator expression>. Return Type: Bag(<ElementType>) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| select | instance.select(<iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Bag(<ElementType>) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| single | instance.single Returns the only element of a collection, and throws an exception if there is not exactly one element in the collection. To instead return a default value when the collection is empty, use SingleOrDefault. Return Type: <ElementType> |
| singleOrDefault | instance.singleOrDefault Returns the only element of a collection, or a default value if the collection is empty. An exception is thrown if there is more than one element in the collection. Return Type: <ElementType> |
| union | instance.union(b) Return Type: Bag(<ElementType>) b - Type: Bag(<ElementType>) |
| union | instance.union(s) Return Type: Set(<ElementType>) s - Type: Set(<ElementType>) |
Boolean type
Represents a Boolean value. Instances of this type have values of either true or false. The Boolean type exposes the following members.
Instance members
| Name | Description |
|---|---|
| toString | instance.toString Returns a string representation of the value. Return Type: String |
CalendarItem type
The CalendarItem type exposes the following members.
Instance members
| Name | Description |
|---|---|
| allDayEvent | instance.allDayEvent Return Type: Boolean |
| attendees | instance.attendees Return Type: Bag(MailAddressee) |
| categories | instance.categories Return Type: Bag(String) |
| contentID | instance.contentID Return Type: Guid |
| description | instance.description Return Type: String |
| endTime | instance.endTime Return Type: CalendarTime |
| file | instance.file Return Type: GeneralFile |
| geographicPosition | instance.geographicPosition Return Type: GeographicPosition |
| importance | instance.importance Return Type: Integer |
| location | instance.location Return Type: String |
| organizer | instance.organizer Return Type: MailAddressee |
| sensitivity | instance.sensitivity Return Type: CalendarItemSensitivity |
| startTime | instance.startTime Return Type: CalendarTime |
| subject | instance.subject Return Type: String |
| uniqueIdentifier | instance.uniqueIdentifier Return Type: String |
CalendarItemSensitivity enumeration
The CalendarItemSensitivity enumeration exposes the following members.
| Name | Description |
|---|---|
| confidential | CalendarItemSensitivity.confidential |
| private | CalendarItemSensitivity.private |
| public | CalendarItemSensitivity.public |
CalendarTime type
Represents an instant in time or a period of a time unit (e.g. a specific day or month), typically expressed as a date and time of day. The CalendarTime type exposes the following members.
Type members
| Name | Description |
|---|---|
| compare | CalendarTime.compare(value1, value2 [, resolution]) Compares two CalendarTime values and returns an integer that indicates whether the first value represents a time that is earlier than, the same as, or later than the second value. The comparison may optionally take a resolution argument indicating the time resolution that should be used for the operation. Return Type: Integer A signed number indicating the ordering of value1 and value2. If the returned value is less than zero value1 is earlier than value2, zero indicates that value1 is the same as value2, and a value greater than zero indicates that value1 is later than value2. value1 - Type: CalendarTime - A CalendarTime value to compare. value2 - Type: CalendarTime - A CalendarTime value to compare. resolution (Optional) - Type: TimeResolution - The time resolution. |
| convertLocalTimeToUtc | CalendarTime.convertLocalTimeToUtc(localTimeValue) Converts the specified local date and time to Coordinated Universal Time (UTC). Return Type: CalendarTime localTimeValue - Type: CalendarTime - The local date and time to to be converted to Coordinated Universal Time (UTC). |
| convertUtcToLocalTime | CalendarTime.convertUtcToLocalTime(utcValue) Converts the specified Coordinated Universal Time (UTC) value to the local date and time. Return Type: CalendarTime utcValue - Type: CalendarTime - The Coordinated Universal Time (UTC) value to be converted to local date and time. |
| maxValue | CalendarTime.maxValue([resolution]) Return Type: CalendarTime resolution (Optional) - Type: TimeResolution - Default Value: TimeResolution.second - The resolution of the CalendarTime returned. Default is a resolution of second. |
| minValue | CalendarTime.minValue([resolution]) Return Type: CalendarTime resolution (Optional) - Type: TimeResolution - Default Value: TimeResolution.second - The resolution of the CalendarTime returned. Default is a resolution of second. |
| new | CalendarTime.new(year [, month] [, day] [, hour] [, minute] [, second] [, millisecond]) Returns a new instance of CalendarTime, with a resolution based on the number of parameters specified. Return Type: CalendarTime year - Type: Integer - The year (1 through 9999). month (Optional) - Type: Integer - The month (1 through 12). day (Optional) - Type: Integer - The day (1 through number of days in the month). hour (Optional) - Type: Integer - The hours (0 through 23). minute (Optional) - Type: Integer - The minutes (0 through 59). second (Optional) - Type: Integer - The seconds (0 through 59). millisecond (Optional) - Type: Integer - The milliseconds (0 through 999). |
| now | CalendarTime.now([resolution]) Returns current date and time on this computer, expressed as the local time. Return Type: CalendarTime resolution (Optional) - Type: TimeResolution - Default Value: TimeResolution.second - The resolution of the CalendarTime returned. Default is a resolution of second. |
| referenceDay | CalendarTime.referenceDay Returns the current reference date. If no reference date has been set, the current date on this computer, expressed as the local time, is returned. Return Type: CalendarTime |
| today | CalendarTime.today Returns current date on this computer, according to the local time. Return Type: CalendarTime |
| tryParseExact | CalendarTime.tryParseExact(s, format, culture [, resolution]) Converts the specified string representation of a date and time to its CalendarTime equivalent using the specified format and culture information. The format of the string representation must match the specified format exactly. Return Type: CalendarTime An instance of CalendarTime or NULL if the string was not successfully converted to date and time. The conversion fails if either the s or format parameter is NULL, is an empty string, or does not contain a date and time that correspond to the pattern specified in format, or culture is not a valid culture. s - Type: String - A string containing a date and time to convert. format - Type: String - The required format of s. For more details, see the MSDN articles "Standard Date and Time Format Strings" (http://msdn.microsoft.com/library/az4se3k1) and "Custom Date and Time Format Strings" (http://msdn.microsoft.com/library/8kb3ddd4). culture - Type: String - The culture name. A NULL value or empty string is interpreted as InvariantCulture, while a single dash "-" is interpreted as CurrentCulture. Otherwise, the value indicates the name of a culture. culture is not case-sensitive. For a list of predefined culture names, see the National Language Support (NLS) API Reference (http://go.microsoft.com/fwlink/?LinkId=200048). resolution (Optional) - Type: TimeResolution - Default Value: TimeResolution.second - The resolution of the CalendarTime returned. Default is a resolution of second. |
| utcNow | CalendarTime.utcNow([resolution]) Returns current date and time on this computer, expressed as the Coordinated Universal Time (UTC). Return Type: CalendarTime resolution (Optional) - Type: TimeResolution - Default Value: TimeResolution.second - The resolution of the CalendarTime returned. Default is a resolution of second. |
Instance members
| Name | Description |
|---|---|
| addDays | instance.addDays(value [, resolution]) Return Type: CalendarTime value - Type: Real resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.days - The time resolution. |
| addHours | instance.addHours(value [, resolution]) Return Type: CalendarTime value - Type: Real resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.hours - The time resolution. |
| addMilliseconds | instance.addMilliseconds(value [, resolution]) Return Type: CalendarTime value - Type: Real resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.milliseconds - The time resolution. |
| addMinutes | instance.addMinutes(value [, resolution]) Return Type: CalendarTime value - Type: Real resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.minutes - The time resolution. |
| addMonths | instance.addMonths(value [, resolution]) Return Type: CalendarTime value - Type: Real resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.months - The time resolution. |
| addSeconds | instance.addSeconds(value [, resolution]) Return Type: CalendarTime value - Type: Real resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.seconds - The time resolution. |
| addYears | instance.addYears(value [, resolution]) Return Type: CalendarTime value - Type: Real resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.years - The time resolution. |
| day | instance.day Returns the day component of the date. Return Type: Integer |
| firstIn7DaysWeek | instance.firstIn7DaysWeek Return Type: CalendarTime |
| firstInCalendarWeek | instance.firstInCalendarWeek Return Type: CalendarTime |
| firstInDay | instance.firstInDay Return Type: CalendarTime |
| firstInHour | instance.firstInHour Return Type: CalendarTime |
| firstInMinute | instance.firstInMinute Return Type: CalendarTime |
| firstInMonth | instance.firstInMonth Return Type: CalendarTime |
| firstInQuarter | instance.firstInQuarter Return Type: CalendarTime |
| firstInYear | instance.firstInYear Return Type: CalendarTime |
| hour | instance.hour Returns the hour component of the date. Return Type: Integer |
| lastIn7DaysWeek | instance.lastIn7DaysWeek Return Type: CalendarTime |
| lastInCalendarWeek | instance.lastInCalendarWeek Return Type: CalendarTime |
| lastInDay | instance.lastInDay Return Type: CalendarTime |
| lastInHour | instance.lastInHour Return Type: CalendarTime |
| lastInMinute | instance.lastInMinute Return Type: CalendarTime |
| lastInMonth | instance.lastInMonth Return Type: CalendarTime |
| lastInQuarter | instance.lastInQuarter Return Type: CalendarTime |
| lastInYear | instance.lastInYear Return Type: CalendarTime |
| millisecond | instance.millisecond Returns the millisecond component of the date. Return Type: Integer |
| minute | instance.minute Returns the minute component of the date. Return Type: Integer |
| month | instance.month Returns the month component of the date. Return Type: Integer |
| next | instance.next Return Type: CalendarTime |
| previous | instance.previous Return Type: CalendarTime |
| resolution | instance.resolution Return Type: TimeResolution |
| second | instance.second Returns the second component of the date. Return Type: Integer |
| timeOfDay | instance.timeOfDay Returns the time of day for this instance. Return Type: CalendarTimeSpan |
| toLongDateTimeString | instance.toLongDateTimeString Return Type: String |
| toShortDateTimeString | instance.toShortDateTimeString Return Type: String |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| toString | instance.toString(format) Return Type: String format - Type: String |
| week | instance.week Returns the week number for the date. Return Type: Integer |
| year | instance.year Returns the year component of the date. Return Type: Integer |
CalendarTimeSpan type
Represents the difference between two instances of CalendarTime. The type is also used to represent time of day. The CalendarTimeSpan type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromDays | CalendarTimeSpan.fromDays(value [, resolution]) Return Type: CalendarTimeSpan value - Type: Real - A number of days, accurate to the nearest millisecond. resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.days - The time resolution. |
| fromHours | CalendarTimeSpan.fromHours(value [, resolution]) Return Type: CalendarTimeSpan value - Type: Real - A number of hours, accurate to the nearest millisecond. resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.hours - The time resolution. |
| fromMilliseconds | CalendarTimeSpan.fromMilliseconds(value [, resolution]) Return Type: CalendarTimeSpan value - Type: Real - A number of milliseconds. resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.milliseconds - The time resolution. |
| fromMinutes | CalendarTimeSpan.fromMinutes(value [, resolution]) Return Type: CalendarTimeSpan value - Type: Real - A number of minutes, accurate to the nearest millisecond. resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.minutes - The time resolution. |
| fromMonths | CalendarTimeSpan.fromMonths(value [, resolution]) Return Type: CalendarTimeSpan value - Type: Real - A number of months. resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.months - The time resolution. |
| fromSeconds | CalendarTimeSpan.fromSeconds(value [, resolution]) Return Type: CalendarTimeSpan value - Type: Real - A number of seconds, accurate to the nearest millisecond. resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.seconds - The time resolution. |
| fromYears | CalendarTimeSpan.fromYears(value [, resolution]) Return Type: CalendarTimeSpan value - Type: Real - A number of years, accurate to the nearest month. resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.years - The time resolution. |
| maxValue | CalendarTimeSpan.maxValue([resolution]) Return Type: CalendarTimeSpan resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.seconds - The time resolution. |
| minValue | CalendarTimeSpan.minValue([resolution]) Return Type: CalendarTimeSpan resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.seconds - The time resolution. |
| zero | CalendarTimeSpan.zero([resolution]) Return Type: CalendarTimeSpan resolution (Optional) - Type: TimeSpanResolution - Default Value: TimeSpanResolution.seconds - The time resolution. |
Instance members
| Name | Description |
|---|---|
| days | instance.days Return Type: Integer |
| hours | instance.hours Return Type: Integer |
| milliseconds | instance.milliseconds Return Type: Integer |
| minutes | instance.minutes Return Type: Integer |
| months | instance.months Return Type: Integer |
| seconds | instance.seconds Return Type: Integer |
| toLongDurationString | instance.toLongDurationString Return Type: String |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| toString | instance.toString(format, culture) Converts the value to its equivalent string representation using the specified format and culture-specific format information. Return Type: String The string representation of the value as specified by format and provider. format - Type: String - A standard or custom TimeSpan format string. For more details, see the MSDN articles "Standard TimeSpan Format Strings" (https://msdn.microsoft.com/en-us/library/ee372286) and "Custom TimeSpan Format Strings" (https://msdn.microsoft.com/en-us/library/ee372287). culture - Type: String - The culture name. A NULL value or empty string is interpreted as InvariantCulture, while a single dash "-" is interpreted as CurrentCulture. Otherwise, the value indicates the name of a culture. culture is not case-sensitive. For a list of predefined culture names, see the National Language Support (NLS) API Reference (http://go.microsoft.com/fwlink/?LinkId=200048). |
| totalDays | instance.totalDays Return Type: Real |
| totalHours | instance.totalHours Return Type: Real |
| totalMilliseconds | instance.totalMilliseconds Return Type: Real |
| totalMinutes | instance.totalMinutes Return Type: Real |
| totalMonths | instance.totalMonths Return Type: Real |
| totalSeconds | instance.totalSeconds Return Type: Real |
| totalYears | instance.totalYears Return Type: Real |
| toTimeOfDayString | instance.toTimeOfDayString Return Type: String |
| years | instance.years Return Type: Integer |
Checksum type
Contains functions for calculating and validating checksums. The Checksum type exposes the following members.
Type members
| Name | Description |
|---|---|
| ibanCalculate | Checksum.ibanCalculate(digits) Calculates a string that is valid according to the IBAN format as defined by ISO 13616-1:2007, based on a template string where the check digits will be replaced. The function does not validate the country-specific properties (including length) of the IBAN code. Return Type: String The same string as specified by the input parameter, but with two check digits in the 3rd and 4th position replaced with calculated check digits. Returns null if the function was unable to calculate a result based on the input. digits - Type: String - A string containing the template for the IBAN code to be calculated represented by characters in the value range between '0' and '9', 'A' and 'Z', and the space character. The string must start with a two-digit country code, followed by two check digits (may be e.g. '00', but any two digits will do as they will be replaced in the return value anyway), followed by a country-specific number of characters. |
| ibanValidate | Checksum.ibanValidate(digits) Verifies that a string is valid according to the IBAN format as defined by ISO 13616-1:2007. The function does not validate the country-specific properties (including length) of the IBAN code. Return Type: Boolean TRUE if the string is valid; otherwise, FALSE. digits - Type: String - A string containing an IBAN code to be validated represented by characters in the value range between '0' and '9', 'A' and 'Z', and the space character. The string must start with a two-digit country code, followed by two check digits, then followed by a country-specific number of characters. |
| mod10Calculate | Checksum.mod10Calculate(digits) Calculates the control digit for a string of numerical digits, according to the Luhn algorithm, also called the "modulus 10" or "mod 10" algorithm. Return Type: String A string containing a single character in the value range between '0' and '9'. digits - Type: String - A string containing characters in the value range between '0' and '9'. |
| mod10Validate | Checksum.mod10Validate(digits) Verifies that a string of numerical digits contains a valid control digit, according to the Luhn algorithm, also called the "modulus 10" or "mod 10" algorithm. Return Type: Boolean TRUE if the string is valid; otherwise, FALSE. digits - Type: String - A string containing characters in the value range between '0' and '9'. |
| mod11Calculate | Checksum.mod11Calculate(digits [, weights] [, reverseOrder]) Calculates the control digit for a string of numerical digits, according to the MOD11 algorithm. Return Type: String A string containing a single character in the value range between '0' and '9'. digits - Type: String - A string containing characters in the value range between '0' and '9'. weights (Optional) - Type: String - Default Value: "234567" - A string used as weigths during calculation, containing characters in the value range between '0' and '9'. reverseOrder (Optional) - Type: Boolean - Default Value: true - TRUE if the checksum should be calculated based on digits weighted in a right to left order (default); otherwise, FALSE. |
| mod11Validate | Checksum.mod11Validate(digits [, weights] [, reverseOrder]) Verifies that a string of numerical digits contains a valid control digit, according to the MOD11 algorithm. Return Type: Boolean TRUE if the string is valid; otherwise, FALSE. digits - Type: String - A string containing characters in the value range between '0' and '9'. weights (Optional) - Type: String - Default Value: "234567" - A string used as weigths during calculation, containing characters in the value range between '0' and '9'. reverseOrder (Optional) - Type: Boolean - Default Value: true - TRUE if the checksum should be calculated based on digits weighted in a right to left order (default); otherwise, FALSE. |
Clipboard type
The Clipboard type exposes the following members.
Type members
| Name | Description |
|---|---|
| getText | Clipboard.getText Retrieves text data from the Clipboard. Return Type: String |
Collection type
The Collection type exposes the following members.
Type members
| Name | Description |
|---|---|
| isNullOrEmpty | Collection.isNullOrEmpty(collection) Indicates whether the specified collection of objects is null or an empty collection. Return Type: Boolean TRUE if the parameter is null or an empty collection; otherwise, FALSE. collection - Type: Collection(Object) - The collection to test. |
| isNullOrEmpty | Collection.isNullOrEmpty(collection) Indicates whether the specified collection of values is null or an empty collection. Return Type: Boolean TRUE if the parameter is null or an empty collection; otherwise, FALSE. collection - Type: Collection(Value) - The collection to test. |
Collection(<ElementType>) type
The Collection(<ElementType>) type exposes the following members.
Instance members
| Name | Description |
|---|---|
| asBag | instance.asBag Return Type: Bag(<ElementType>) |
| asOrderedSet | instance.asOrderedSet Return Type: OrderedSet(<ElementType>) |
| asSequence | instance.asSequence Return Type: Sequence(<ElementType>) |
| asSet | instance.asSet Return Type: Set(<ElementType>) |
| count | instance.count Return Type: Integer |
| count | instance.count(object) Return Type: Integer object - Type: <ElementType> |
| emptyIfNull | instance.emptyIfNull Returns the empty collection if the instance is null; otherwise, the instance is returned. Return Type: Collection(<ElementType>) |
| excludes | instance.excludes(object) Return Type: Boolean object - Type: <ElementType> |
| excludesAll | instance.excludesAll(c2) Return Type: Boolean c2 - Type: Collection(<ElementType>) |
| excluding | instance.excluding(object) Return Type: Collection(<ElementType>) object - Type: <ElementType> |
| exists | instance.exists(<iterator expression>) Returns TRUE if at least one Collection(<ElementType>) instance match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| forAll | instance.forAll(<iterator expression>) Returns TRUE if all Collection(<ElementType>) instances match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| includes | instance.includes(object) Return Type: Boolean object - Type: <ElementType> |
| includesAll | instance.includesAll(c2) Return Type: Boolean c2 - Type: Collection(<ElementType>) |
| including | instance.including(object) Return Type: Collection(<ElementType>) object - Type: <ElementType> |
| isEmpty | instance.isEmpty Return Type: Boolean |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Collection(<ElementType>) joinWith - Type: Collection(Object) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Collection(<ElementType>) joinWith - Type: Collection(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| notEmpty | instance.notEmpty Return Type: Boolean |
| reject | instance.reject(<iterator expression>) Removes all instances of <ElementType> that match the <iterator expression>. Return Type: Collection(<ElementType>) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| select | instance.select(<iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Collection(<ElementType>) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| single | instance.single Returns the only element of a collection, and throws an exception if there is not exactly one element in the collection. To instead return a default value when the collection is empty, use SingleOrDefault. Return Type: <ElementType> |
| singleOrDefault | instance.singleOrDefault Returns the only element of a collection, or a default value if the collection is empty. An exception is thrown if there is more than one element in the collection. Return Type: <ElementType> |
Collection(CalendarTimeSpan) type
The Collection(CalendarTimeSpan) type exposes the following members.
Instance members
| Name | Description |
|---|---|
| asBag | instance.asBag Return Type: Bag(CalendarTimeSpan) |
| asOrderedSet | instance.asOrderedSet Return Type: OrderedSet(CalendarTimeSpan) |
| asSequence | instance.asSequence Return Type: Sequence(CalendarTimeSpan) |
| asSet | instance.asSet Return Type: Set(CalendarTimeSpan) |
| average | instance.average Returns the average (arithmetic mean) of a collection of values. Return Type: CalendarTimeSpan |
| count | instance.count Return Type: Integer |
| count | instance.count(object) Return Type: Integer object - Type: CalendarTimeSpan |
| emptyIfNull | instance.emptyIfNull Returns the empty collection if the instance is null; otherwise, the instance is returned. Return Type: Collection(CalendarTimeSpan) |
| excludes | instance.excludes(object) Return Type: Boolean object - Type: CalendarTimeSpan |
| excludesAll | instance.excludesAll(c2) Return Type: Boolean c2 - Type: Collection(CalendarTimeSpan) |
| excluding | instance.excluding(object) Return Type: Collection(CalendarTimeSpan) object - Type: CalendarTimeSpan |
| excluding | instance.excluding(object) Return Type: Collection(Value) object - Type: Value |
| exists | instance.exists(<iterator expression>) Returns TRUE if at least one Collection(CalendarTimeSpan) instance match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type CalendarTimeSpan. |
| forAll | instance.forAll(<iterator expression>) Returns TRUE if all Collection(CalendarTimeSpan) instances match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type CalendarTimeSpan. |
| includes | instance.includes(object) Return Type: Boolean object - Type: CalendarTimeSpan |
| includesAll | instance.includesAll(c2) Return Type: Boolean c2 - Type: Collection(CalendarTimeSpan) |
| including | instance.including(object) Return Type: Collection(CalendarTimeSpan) object - Type: CalendarTimeSpan |
| including | instance.including(object) Return Type: Collection(Value) object - Type: Value |
| isEmpty | instance.isEmpty Return Type: Boolean |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of CalendarTimeSpan that match the <iterator expression>. Return Type: Collection(CalendarTimeSpan) joinWith - Type: Collection(Object) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type CalendarTimeSpan. |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of CalendarTimeSpan that match the <iterator expression>. Return Type: Collection(CalendarTimeSpan) joinWith - Type: Collection(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type CalendarTimeSpan. |
| max | instance.max Returns the largest value in a collection of values. Return Type: CalendarTimeSpan |
| min | instance.min Returns the smallest value in a collection of values. Return Type: CalendarTimeSpan |
| notEmpty | instance.notEmpty Return Type: Boolean |
| reject | instance.reject(<iterator expression>) Removes all instances of CalendarTimeSpan that match the <iterator expression>. Return Type: Collection(CalendarTimeSpan) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type CalendarTimeSpan. |
| select | instance.select(<iterator expression>) Selects only those instances of CalendarTimeSpan that match the <iterator expression>. Return Type: Collection(CalendarTimeSpan) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type CalendarTimeSpan. |
| single | instance.single Returns the only element of a collection, and throws an exception if there is not exactly one element in the collection. To instead return a default value when the collection is empty, use SingleOrDefault. Return Type: CalendarTimeSpan |
| singleOrDefault | instance.singleOrDefault Returns the only element of a collection, or a default value if the collection is empty. An exception is thrown if there is more than one element in the collection. Return Type: CalendarTimeSpan |
| sum | instance.sum Returns the sum of a collection of values. Return Type: CalendarTimeSpan |
| toString | instance.toString Returns a string representation of the values. Return Type: String |
Collection(Integer) type
The Collection(Integer) type exposes the following members.
Instance members
| Name | Description |
|---|---|
| asBag | instance.asBag Return Type: Bag(Integer) |
| asOrderedSet | instance.asOrderedSet Return Type: OrderedSet(Integer) |
| asSequence | instance.asSequence Return Type: Sequence(Integer) |
| asSet | instance.asSet Return Type: Set(Integer) |
| average | instance.average Returns the average (arithmetic mean) of a collection of values. Return Type: Real |
| count | instance.count Return Type: Integer |
| count | instance.count(object) Return Type: Integer object - Type: Integer |
| emptyIfNull | instance.emptyIfNull Returns the empty collection if the instance is null; otherwise, the instance is returned. Return Type: Collection(Integer) |
| excludes | instance.excludes(object) Return Type: Boolean object - Type: Integer |
| excludesAll | instance.excludesAll(c2) Return Type: Boolean c2 - Type: Collection(Integer) |
| excluding | instance.excluding(object) Return Type: Collection(Integer) object - Type: Integer |
| excluding | instance.excluding(object) Return Type: Collection(Value) object - Type: Value |
| exists | instance.exists(<iterator expression>) Returns TRUE if at least one Collection(Integer) instance match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Integer. |
| forAll | instance.forAll(<iterator expression>) Returns TRUE if all Collection(Integer) instances match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Integer. |
| includes | instance.includes(object) Return Type: Boolean object - Type: Integer |
| includesAll | instance.includesAll(c2) Return Type: Boolean c2 - Type: Collection(Integer) |
| including | instance.including(object) Return Type: Collection(Integer) object - Type: Integer |
| including | instance.including(object) Return Type: Collection(Value) object - Type: Value |
| isEmpty | instance.isEmpty Return Type: Boolean |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of Integer that match the <iterator expression>. Return Type: Collection(Integer) joinWith - Type: Collection(Object) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Integer. |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of Integer that match the <iterator expression>. Return Type: Collection(Integer) joinWith - Type: Collection(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Integer. |
| max | instance.max Returns the largest value in a collection of values. Return Type: Integer |
| median | instance.median Returns the median of the given values. The median is the value in the middle of a collection of values; that is, half the values are greater than the median, and half are less. Return Type: Real |
| min | instance.min Returns the smallest value in a collection of values. Return Type: Integer |
| norm | instance.norm Returns the Euclidean "L-2" norm for the data values (the square root of the sum of squares). Return Type: Real |
| notEmpty | instance.notEmpty Return Type: Boolean |
| percentileCont | instance.percentileCont(percentile, sortOrder) Returns the percentile based on a continuous distribution of the data values. The result is interpolated and might not be equal to any of the specific data values. Return Type: Real percentile - Type: Real - The percentile to compute. The value must range between 0.0 and 1.0. sortOrder - Type: SortOrder - The order applied when data values are sorted (ascending or descending). |
| reject | instance.reject(<iterator expression>) Removes all instances of Integer that match the <iterator expression>. Return Type: Collection(Integer) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Integer. |
| select | instance.select(<iterator expression>) Selects only those instances of Integer that match the <iterator expression>. Return Type: Collection(Integer) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Integer. |
| single | instance.single Returns the only element of a collection, and throws an exception if there is not exactly one element in the collection. To instead return a default value when the collection is empty, use SingleOrDefault. Return Type: Integer |
| singleOrDefault | instance.singleOrDefault Returns the only element of a collection, or a default value if the collection is empty. An exception is thrown if there is more than one element in the collection. Return Type: Integer |
| stdev | instance.stdev Estimates standard deviation based on a sample. The standard deviation is a measure of how widely values are dispersed from the average value (the mean). Return Type: Real |
| stdevp | instance.stdevp Calculates standard deviation based on the entire population given as arguments. The standard deviation is a measure of how widely values are dispersed from the average value (the mean). Return Type: Real |
| sum | instance.sum Returns the sum of a collection of values. Return Type: Integer |
| sumsq | instance.sumsq Returns the sum of the squares of a collection of values. Return Type: Integer |
| toString | instance.toString Returns a string representation of the values. Return Type: String |
| var | instance.var Estimates variance based on a sample. Var assumes that its arguments are a sample of the population. If your data represents the entire population, then compute the variance using Varp. Return Type: Real |
| varp | instance.varp Calculates variance based on the entire population. Varp assumes that its arguments are the entire population. If your data represents a sample of the population, then compute the variance using Var. Return Type: Real |
| vart | instance.vart Returns the sum of the squares of the difference between each data value and the mean of the data values. Return Type: Real |
Collection(Real) type
The Collection(Real) type exposes the following members.
Instance members
| Name | Description |
|---|---|
| asBag | instance.asBag Return Type: Bag(Real) |
| asOrderedSet | instance.asOrderedSet Return Type: OrderedSet(Real) |
| asSequence | instance.asSequence Return Type: Sequence(Real) |
| asSet | instance.asSet Return Type: Set(Real) |
| average | instance.average Returns the average (arithmetic mean) of a collection of values. Return Type: Real |
| count | instance.count Return Type: Integer |
| count | instance.count(object) Return Type: Integer object - Type: Real |
| emptyIfNull | instance.emptyIfNull Returns the empty collection if the instance is null; otherwise, the instance is returned. Return Type: Collection(Real) |
| excludes | instance.excludes(object) Return Type: Boolean object - Type: Real |
| excludesAll | instance.excludesAll(c2) Return Type: Boolean c2 - Type: Collection(Real) |
| excluding | instance.excluding(object) Return Type: Collection(Real) object - Type: Real |
| excluding | instance.excluding(object) Return Type: Collection(Value) object - Type: Value |
| exists | instance.exists(<iterator expression>) Returns TRUE if at least one Collection(Real) instance match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Real. |
| forAll | instance.forAll(<iterator expression>) Returns TRUE if all Collection(Real) instances match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Real. |
| includes | instance.includes(object) Return Type: Boolean object - Type: Real |
| includesAll | instance.includesAll(c2) Return Type: Boolean c2 - Type: Collection(Real) |
| including | instance.including(object) Return Type: Collection(Real) object - Type: Real |
| including | instance.including(object) Return Type: Collection(Value) object - Type: Value |
| isEmpty | instance.isEmpty Return Type: Boolean |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of Real that match the <iterator expression>. Return Type: Collection(Real) joinWith - Type: Collection(Object) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Real. |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of Real that match the <iterator expression>. Return Type: Collection(Real) joinWith - Type: Collection(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Real. |
| max | instance.max Returns the largest value in a collection of values. Return Type: Real |
| median | instance.median Returns the median of the given values. The median is the value in the middle of a collection of values; that is, half the values are greater than the median, and half are less. Return Type: Real |
| min | instance.min Returns the smallest value in a collection of values. Return Type: Real |
| norm | instance.norm Returns the Euclidean "L-2" norm for the data values (the square root of the sum of squares). Return Type: Real |
| notEmpty | instance.notEmpty Return Type: Boolean |
| percentileCont | instance.percentileCont(percentile, sortOrder) Returns the percentile based on a continuous distribution of the data values. The result is interpolated and might not be equal to any of the specific data values. Return Type: Real percentile - Type: Real - The percentile to compute. The value must range between 0.0 and 1.0. sortOrder - Type: SortOrder - The order applied when data values are sorted (ascending or descending). |
| reject | instance.reject(<iterator expression>) Removes all instances of Real that match the <iterator expression>. Return Type: Collection(Real) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Real. |
| select | instance.select(<iterator expression>) Selects only those instances of Real that match the <iterator expression>. Return Type: Collection(Real) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Real. |
| single | instance.single Returns the only element of a collection, and throws an exception if there is not exactly one element in the collection. To instead return a default value when the collection is empty, use SingleOrDefault. Return Type: Real |
| singleOrDefault | instance.singleOrDefault Returns the only element of a collection, or a default value if the collection is empty. An exception is thrown if there is more than one element in the collection. Return Type: Real |
| stdev | instance.stdev Estimates standard deviation based on a sample. The standard deviation is a measure of how widely values are dispersed from the average value (the mean). Return Type: Real |
| stdevp | instance.stdevp Calculates standard deviation based on the entire population given as arguments. The standard deviation is a measure of how widely values are dispersed from the average value (the mean). Return Type: Real |
| sum | instance.sum Returns the sum of a collection of values. Return Type: Real |
| sumsq | instance.sumsq Returns the sum of the squares of a collection of values. Return Type: Real |
| toString | instance.toString Returns a string representation of the values. Return Type: String |
| var | instance.var Estimates variance based on a sample. Var assumes that its arguments are a sample of the population. If your data represents the entire population, then compute the variance using Varp. Return Type: Real |
| varp | instance.varp Calculates variance based on the entire population. Varp assumes that its arguments are the entire population. If your data represents a sample of the population, then compute the variance using Var. Return Type: Real |
| vart | instance.vart Returns the sum of the squares of the difference between each data value and the mean of the data values. Return Type: Real |
Contact type
The Contact type exposes the following members.
Instance members
| Name | Description |
|---|---|
| addresses | instance.addresses Return Type: Addresses |
| company | instance.company Return Type: String |
| contentID | instance.contentID Return Type: Guid |
| file | instance.file Return Type: GeneralFile |
| geographicPosition | instance.geographicPosition Return Type: GeographicPosition |
| jobTitle | instance.jobTitle Return Type: String |
| instance.mail Return Type: String |
|
| name | instance.name Return Type: Name |
| phoneNumbers | instance.phoneNumbers Return Type: ContactPhoneNumbers |
| photo | instance.photo Return Type: GeneralFile |
| webPage | instance.webPage Return Type: Url |
ContactAddress type
The ContactAddress type exposes the following members.
Instance members
| Name | Description |
|---|---|
| city | instance.city Return Type: String |
| country_Region | instance.country_Region Return Type: String |
| state_Province | instance.state_Province Return Type: String |
| street | instance.street Return Type: String |
| zipCode | instance.zipCode Return Type: String |
ContactPhoneNumbers type
The ContactPhoneNumbers type exposes the following members.
Instance members
| Name | Description |
|---|---|
| business | instance.business Return Type: ContactPhoneNumbersLocation |
| home | instance.home Return Type: ContactPhoneNumbersLocation |
| mobile | instance.mobile Return Type: String |
ContactPhoneNumbersLocation type
The ContactPhoneNumbersLocation type exposes the following members.
Instance members
| Name | Description |
|---|---|
| fax | instance.fax Return Type: String |
| phone | instance.phone Return Type: String |
DataSet type
The DataSet type exposes the following members.
Type members
| Name | Description |
|---|---|
| activeDataSet | DataSet.activeDataSet Returns the active data set. Return Type: DataSet |
Instance members
| Name | Description |
|---|---|
| currentFolder | instance.currentFolder Return Type: String |
| name | instance.name Return Type: String |
Date type
Represents an instant in time, expressed as a date. The Date type exposes the following members.
Type members
| Name | Description |
|---|---|
| new | Date.new(year, month, day) Return Type: Date year - Type: Integer month - Type: Integer day - Type: Integer |
| now | Date.now Return Type: Date |
| utcNow | Date.utcNow Return Type: Date |
Instance members
| Name | Description |
|---|---|
| addDays | instance.addDays(value) Return Type: Date value - Type: Integer |
| addMonths | instance.addMonths(value) Return Type: Date value - Type: Integer |
| addYears | instance.addYears(value) Return Type: Date value - Type: Integer |
| day | instance.day Return Type: Integer |
| dayOfWeek | instance.dayOfWeek Return Type: Integer |
| iso8601DayOfWeek | instance.iso8601DayOfWeek Return Type: Integer |
| month | instance.month Return Type: Integer |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| toString | instance.toString(format) Return Type: String format - Type: String |
| year | instance.year Return Type: Integer |
DateTime type
Represents an instant in time, expressed as a date and time of day. The DateTime type exposes the following members.
Type members
| Name | Description |
|---|---|
| convertLocalTimeToUtc | DateTime.convertLocalTimeToUtc(localTimeValue) Converts the specified local date and time to Coordinated Universal Time (UTC). Return Type: DateTime localTimeValue - Type: DateTime - The local date and time to to be converted to Coordinated Universal Time (UTC). |
| convertUtcToLocalTime | DateTime.convertUtcToLocalTime(utcValue) Converts the specified Coordinated Universal Time (UTC) value to the local date and time. Return Type: DateTime utcValue - Type: DateTime - The Coordinated Universal Time (UTC) value to be converted to local date and time. |
| new | DateTime.new(year, month, day) Return Type: DateTime year - Type: Integer month - Type: Integer day - Type: Integer |
| new | DateTime.new(year, month, day, hour, minute, second) Return Type: DateTime year - Type: Integer month - Type: Integer day - Type: Integer hour - Type: Integer minute - Type: Integer second - Type: Integer |
| new | DateTime.new(year, month, day, hour, minute, second, millisecond) Return Type: DateTime year - Type: Integer month - Type: Integer day - Type: Integer hour - Type: Integer minute - Type: Integer second - Type: Integer millisecond - Type: Integer |
| now | DateTime.now Return Type: DateTime |
| utcNow | DateTime.utcNow Return Type: DateTime |
Instance members
| Name | Description |
|---|---|
| addDays | instance.addDays(value) Return Type: DateTime value - Type: Integer |
| addHours | instance.addHours(value) Return Type: DateTime value - Type: Integer |
| addMilliseconds | instance.addMilliseconds(value) Return Type: DateTime value - Type: Integer |
| addMinutes | instance.addMinutes(value) Return Type: DateTime value - Type: Integer |
| addMonths | instance.addMonths(value) Return Type: DateTime value - Type: Integer |
| addSeconds | instance.addSeconds(value) Return Type: DateTime value - Type: Integer |
| addYears | instance.addYears(value) Return Type: DateTime value - Type: Integer |
| date | instance.date Return Type: Date |
| day | instance.day Return Type: Integer |
| dayOfWeek | instance.dayOfWeek Return Type: Integer |
| hour | instance.hour Return Type: Integer |
| iso8601DayOfWeek | instance.iso8601DayOfWeek Return Type: Integer |
| millisecond | instance.millisecond Return Type: Integer |
| minute | instance.minute Return Type: Integer |
| month | instance.month Return Type: Integer |
| second | instance.second Return Type: Integer |
| time | instance.time Return Type: Time |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| toString | instance.toString(format) Return Type: String format - Type: String |
| year | instance.year Return Type: Integer |
Day type
The Day type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | Day.fromCalendarTime(value) Return Type: Day value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| date | instance.date Return Type: CalendarTime |
| dayAndYearName | instance.dayAndYearName Return Type: String |
| dayNumberOfTheWeekNo_ISO8601 | instance.dayNumberOfTheWeekNo_ISO8601 Return Type: Integer |
| dayNumberOfYear | instance.dayNumberOfYear Return Type: Integer |
| dayOfMonth | instance.dayOfMonth Return Type: Integer |
| dayOfWeekName | instance.dayOfWeekName Return Type: String |
| dayOfWeekShortName | instance.dayOfWeekShortName Return Type: String |
| id | instance.id Return Type: CalendarTime |
| month | instance.month Return Type: Month |
| monthName | instance.monthName Return Type: String |
| periodType | instance.periodType Return Type: Integer |
| week | instance.week Return Type: Week |
| yearNumber | instance.yearNumber Return Type: Integer |
Directory type
The Directory type exposes the following members.
Type members
| Name | Description |
|---|---|
| currentLanguage | Directory.currentLanguage Returns the current language in use by the running Genus session. Return Type: NaturalLanguage |
| name | Directory.name Return Type: String |
| temporaryFolder | Directory.temporaryFolder Returns the location of the temporary folder used by Genus. Note that the folder and all its contents are removed when you exit Genus. Return Type: String |
DueDate enumeration
The DueDate class defines functions used to identify where a due date falls within a date interval. The DueDate enumeration exposes the following members.
| Name | Description |
|---|---|
| begOfPeriod | DueDate.begOfPeriod Interest is calculated on the principal balance at the beginning of the payment period. |
| endOfPeriod | DueDate.endOfPeriod Interest is calculated on the principal balance at the end of the payment period. |
Encoding enumeration
Enumerates the available encodings available for a string. The Encoding enumeration exposes the following members.
| Name | Description |
|---|---|
| ansi | Encoding.ansi ANSI encoding. Each Unicode code point is translated into a byte using the current code page. |
| utf16 | Encoding.utf16 UTF-16 encoding. Represents each Unicode code point as a sequence of one or two 16-bit integers. |
| utf8 | Encoding.utf8 UTF-8 encoding. Represents each Unicode code point as a sequence of one to four bytes. |
Environment type
The Environment type exposes the following members.
Type members
| Name | Description |
|---|---|
| msOutlookInstalled | Environment.msOutlookInstalled Returns TRUE if Microsoft Outlook is installed on the current computer. Return Type: Boolean |
EventHistory type
The EventHistory type exposes the following members.
Instance members
| Name | Description |
|---|---|
| account | instance.account Return Type: String |
| date | instance.date Return Type: CalendarTime |
| event | instance.event Return Type: String |
| identifier | instance.identifier Return Type: Guid |
| object | instance.object Return Type: String |
| objectType | instance.objectType Return Type: String |
| steps | instance.steps Return Type: Bag(AuditTrailStep) |
FileFolder type
The FileFolder type exposes the following members.
Instance members
| Name | Description |
|---|---|
| contentID | instance.contentID Return Type: Guid |
| createdDate | instance.createdDate Return Type: CalendarTime |
| drive | instance.drive Return Type: String |
| files | instance.files Return Type: Bag(Files) |
| modifiedDate | instance.modifiedDate Return Type: CalendarTime |
| name | instance.name Return Type: String |
| path | instance.path Return Type: String |
FileFormat enumeration
The FileFormat enumeration exposes the following members.
| Name | Description |
|---|---|
| bitmapImage | FileFormat.bitmapImage |
| commaSeparatedValues | FileFormat.commaSeparatedValues |
| default | FileFormat.default |
| enhancedMetafile | FileFormat.enhancedMetafile |
| excel97_2003Workbook | FileFormat.excel97_2003Workbook |
| excelWorkbook | FileFormat.excelWorkbook |
| gifImage | FileFormat.gifImage |
| hTMLDocument | FileFormat.hTMLDocument |
| jpegImage | FileFormat.jpegImage |
| pDFDocument | FileFormat.pDFDocument |
| portableNetworkGraphics | FileFormat.portableNetworkGraphics |
| richTextFormat | FileFormat.richTextFormat |
| textDocument | FileFormat.textDocument |
| xPSDocument | FileFormat.xPSDocument |
Finance type
The Finance type exposes the following members.
Type members
| Name | Description |
|---|---|
| FV | Finance.FV(rate, nper, pmt [, pv] [, paytime]) Returns the future value of an investment based on periodic, constant payments and a constant interest rate. Return Type: Real rate - Type: Real - The interest rate per period. nper - Type: Integer - The total number of payment periods in an annuity. pmt - Type: Real - The payment made each period; it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes. If pmt is 0 (zero), you must include the pv argument. pv (Optional) - Type: Real - The present value, or the lump-sum amount that a series of future payments is worth right now. If pv is 0 (zero), you must include the pmt argument. paytime (Optional) - Type: DueDate - Default Value: DueDate.endOfPeriod - Indicates when payments are due. |
| IPMT | Finance.IPMT(rate, per, nper, pv [, fv] [, paytime]) Returns the interest payment for a given period for an investment based on periodic, constant payments and a constant interest rate. Return Type: Real rate - Type: Real - The interest rate per period. per - Type: Integer - The period for which you want to find the interest and must be in the range 1 to nper. nper - Type: Integer - The total number of payment periods in an annuity. pv - Type: Real - The present value, or the lump-sum amount that a series of future payments is worth right now. fv (Optional) - Type: Real - Default Value: 0.0 - Future value, or a cash balance you want to attain after the last payment is made. The argument fv may be 0 (the future value of a loan, for example, is 0). paytime (Optional) - Type: DueDate - Default Value: DueDate.endOfPeriod - Indicates when payments are due. |
| IRR | Finance.IRR(values [, guess]) Returns the internal rate of return for a series of cash flows represented by the values. Return Type: Real values - Type: Collection(Real) - A list that contain values for which you want to calculate the internal rate of return. guess (Optional) - Type: Real - A number that you guess is close to the result of IRR. |
| NPER | Finance.NPER(rate, pmt, pv [, fv] [, paytime]) Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate. Return Type: Real rate - Type: Real - The interest rate per period. pmt - Type: Real - The payment made each period; it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes. pv - Type: Real - The present value, or the lump-sum amount that a series of future payments is worth right now. fv (Optional) - Type: Real - Default Value: 0.0 - Future value, or a cash balance you want to attain after the last payment is made. The argument fv may be 0 (the future value of a loan, for example, is 0). paytime (Optional) - Type: DueDate - Default Value: DueDate.endOfPeriod - Indicates when payments are due. |
| NPV | Finance.NPV(rate, values) Calculates the net present value of an investment by using a discount rate and a series of future payments (negative values) and income (positive values). Return Type: Real rate - Type: Real - The rate of discount over the length of one period. values - Type: Collection(Real) - A list of values representing the payments and income. |
| PMT | Finance.PMT(rate, nper, pv [, fv] [, paytime]) Calculates the payment for a loan based on constant payments and a constant interest rate. Return Type: Real rate - Type: Real - The interest rate per period. nper - Type: Integer - The total number of payments for the loan. pv - Type: Real - The present value, or the total amount that a series of future payments is worth now; also known as the principal. fv (Optional) - Type: Real - Default Value: 0.0 - Future value, or a cash balance you want to attain after the last payment is made. The argument fv may be 0 (the future value of a loan, for example, is 0). paytime (Optional) - Type: DueDate - Default Value: DueDate.endOfPeriod - Indicates when payments are due. |
| PPMT | Finance.PPMT(rate, per, nper, pv [, fv] [, paytime]) Returns the payment on the principal for a given period for an investment based on periodic, constant payments and a constant interest rate. Return Type: Real rate - Type: Real - The interest rate per period. per - Type: Integer - The period for which you want to find the interest and must be in the range 1 to nper. nper - Type: Integer - The total number of payment periods in an annuity. pv - Type: Real - The present value, or the lump-sum amount that a series of future payments is worth right now. fv (Optional) - Type: Real - Default Value: 0.0 - Future value, or a cash balance you want to attain after the last payment is made. The argument fv may be 0 (the future value of a loan, for example, is 0). paytime (Optional) - Type: DueDate - Default Value: DueDate.endOfPeriod - Indicates when payments are due. |
| PV | Finance.PV(rate, nper, pmt [, fv] [, paytime]) Returns the present value of an investment. The present value is the total amount that a series of future payments is worth now. Return Type: Real rate - Type: Real - The interest rate per period. nper - Type: Integer - The total number of payment periods in an annuity. pmt - Type: Real - The payment made each period; it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes. fv (Optional) - Type: Real - Default Value: 0.0 - Future value, or a cash balance you want to attain after the last payment is made. The argument fv may be 0 (the future value of a loan, for example, is 0). paytime (Optional) - Type: DueDate - Default Value: DueDate.endOfPeriod - Indicates when payments are due. |
| rate | Finance.rate(nper, pmt, pv [, fv] [, paytime]) Returns the interest rate per period of an annuity. Return Type: Real nper - Type: Integer - The total number of payment periods in an annuity. pmt - Type: Real - The payment made each period; it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes. If pmt is 0 (zero), you must include the fv argument. pv - Type: Real - The present value, or the lump-sum amount that a series of future payments is worth right now. fv (Optional) - Type: Real - Default Value: 0.0 - Future value, or a cash balance you want to attain after the last payment is made. The argument fv may be 0 (the future value of a loan, for example, is 0). paytime (Optional) - Type: DueDate - Default Value: DueDate.endOfPeriod - Indicates when payments are due. |
GanttTaskDependency type
The GanttTaskDependency type exposes the following members.
Type members
| Name | Description |
|---|---|
| finish_to_Finish_FF | GanttTaskDependency.finish_to_Finish_FF Return Type: GanttTaskDependency |
| finish_to_Start_FS | GanttTaskDependency.finish_to_Start_FS Return Type: GanttTaskDependency |
| ocGroup | GanttTaskDependency.ocGroup Return Type: String |
| ocName | GanttTaskDependency.ocName Return Type: String |
| start_to_Finish_SF | GanttTaskDependency.start_to_Finish_SF Return Type: GanttTaskDependency |
| start_to_Start_SS | GanttTaskDependency.start_to_Start_SS Return Type: GanttTaskDependency |
Instance members
| Name | Description |
|---|---|
| allObjects | instance.allObjects Return Type: Set(GanttTaskDependency) |
| hasDeletePermissions | instance.hasDeletePermissions Return Type: Boolean |
| hasModifyPermissions | instance.hasModifyPermissions Return Type: Boolean |
| id | instance.id Return Type: Integer |
| isModified | instance.isModified Return Type: Boolean |
| isPersisted | instance.isPersisted Return Type: Boolean |
| isValid | instance.isValid Return Type: Boolean |
| name | instance.name Return Type: String |
| orderIndex | instance.orderIndex Return Type: Integer |
GeneralFile type
The GeneralFile type exposes the following members.
Instance members
| Name | Description |
|---|---|
| attachment_ContentID | instance.attachment_ContentID Return Type: String |
| attachment_ContentLocation | instance.attachment_ContentLocation Return Type: String |
| attachment_DisplayName | instance.attachment_DisplayName Return Type: String |
| attachment_Embedded | instance.attachment_Embedded Return Type: Boolean |
| attachment_Type | instance.attachment_Type Return Type: MessageAttachmentType |
| author | instance.author Return Type: String |
| bitDepth | instance.bitDepth Return Type: Integer |
| category | instance.category Return Type: String |
| comments | instance.comments Return Type: String |
| contentID | instance.contentID Return Type: Guid |
| createdDate | instance.createdDate Return Type: CalendarTime |
| data | instance.data Return Type: StreamData |
| duration | instance.duration Return Type: Integer |
| fileExtension | instance.fileExtension Return Type: String |
| fileName | instance.fileName Return Type: String |
| geographicPosition | instance.geographicPosition Return Type: GeographicPosition |
| height | instance.height Return Type: Integer |
| keywords | instance.keywords Return Type: String |
| modifiedBy | instance.modifiedBy Return Type: String |
| modifiedDate | instance.modifiedDate Return Type: CalendarTime |
| numberOfCharacters | instance.numberOfCharacters Return Type: Integer |
| numberOfPages | instance.numberOfPages Return Type: Integer |
| numberOfWords | instance.numberOfWords Return Type: Integer |
| read_Only | instance.read_Only Return Type: Boolean |
| revisionNumber | instance.revisionNumber Return Type: String |
| size | instance.size Return Type: Integer |
| subject | instance.subject Return Type: String |
| title | instance.title Return Type: String |
| width | instance.width Return Type: Integer |
GeographicPosition type
The GeographicPosition type exposes the following members.
Instance members
| Name | Description |
|---|---|
| latitude | instance.latitude Return Type: Real |
| longitude | instance.longitude Return Type: Real |
Guid type
Represents a globally unique identifier (GUID). A GUID is a 128-bit integer (16 bytes) that can be used across all computers and networks wherever a unique identifier is required. The Guid type exposes the following members.
Type members
| Name | Description |
|---|---|
| new | Guid.new(value) Creates a new instance of the Guid class using the value represented by the specified string. Return Type: Guid value - Type: String - A String that contains a GUID in one of the following formats ('d' represents a hexadecimal digit whose case is ignored): |
"dddddddddddddddddddddddddddddddd", "dddddddd-dddd-dddd-dddd-dddddddddddd", or "{dddddddd-dddd-dddd-dddd-dddddddddddd}".
newGuid | Guid.newGuid
Creates a new instance of the Guid class with a new, random value.
Return Type: Guid
Instance members
| Name | Description |
|---|---|
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| toString | instance.toString(format) Returns a string representation of the value of this Guid instance, according to the provided format specifier. The following list shows the accepted format specifiers for the format parameter. "0" represents a digit; hyphens ("-"), braces ("{", "}"), and parentheses ("(", ")") appear as shown: "N" (32 digits): 00000000000000000000000000000000 "D" (32 digits separated by hyphens): 00000000-0000-0000-0000-000000000000 "B" (32 digits separated by hyphens, enclosed in braces): {00000000-0000-0000-0000-000000000000} "P" (32 digits separated by hyphens, enclosed in parentheses): (00000000-0000-0000-0000-000000000000) "X" (Four hexadecimal values enclosed in braces, where the fourth value is a subset of eight hexadecimal values that is also enclosed in braces): {0x00000000,0x0000,0x0000,{0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00}}. Return Type: String The value of this Guid, represented as a series of lowercase hexadecimal digits in the specified format. format - Type: String - A single format specifier that indicates how to format the value of this Guid. The format parameter can be "N", "D", "B", "P", or "X". If format is null or an empty string (""), "D" is used. |
HalfMonth type
The HalfMonth type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | HalfMonth.fromCalendarTime(value) Return Type: HalfMonth value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| endDate | instance.endDate Return Type: CalendarTime |
| halfMonthAndYearName | instance.halfMonthAndYearName Return Type: String |
| id | instance.id Return Type: CalendarTime |
| periodType | instance.periodType Return Type: Integer |
| sequenceNumber | instance.sequenceNumber Return Type: Integer |
| yearNumber | instance.yearNumber Return Type: Integer |
HalfYear type
The HalfYear type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | HalfYear.fromCalendarTime(value) Return Type: HalfYear value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| endDate | instance.endDate Return Type: CalendarTime |
| halfYearAndYearName | instance.halfYearAndYearName Return Type: String |
| id | instance.id Return Type: CalendarTime |
| periodType | instance.periodType Return Type: Integer |
| sequenceNumber | instance.sequenceNumber Return Type: Integer |
| startDate | instance.startDate Return Type: CalendarTime |
| yearNumber | instance.yearNumber Return Type: Integer |
HashAlgorithm type
Represents a hash algorithm. The HashAlgorithm type exposes the following members.
Type members
| Name | Description |
|---|---|
| create | HashAlgorithm.create(hashName) Creates an instance of the specified implementation of a hash algorithm. Return Type: HashAlgorithm A new instance of the specified hash algorithm, or null if hashName is not a valid hash algorithm. hashName - Type: String - The hash algorithm implementation to use. One of the following values: "SHA1", "MD5", "SHA256", "SHA384", or "SHA512". |
Instance members
| Name | Description |
|---|---|
| computeHash | instance.computeHash(inputStream) Computes the hash value for the specified StreamData object. Return Type: StreamData The computed hash code. inputStream - Type: StreamData - The input data for which to compute the hash code. |
HtmlDocument type
Represents an HTML document. The HtmlDocument type exposes the following members.
Type members
| Name | Description |
|---|---|
| createFromMarkdown | HtmlDocument.createFromMarkdown(value) Returns a new instance of HtmlDocument. Return Type: HtmlDocument value - Type: String - The string containing the Markdown formatted data. |
| createFromPlainText | HtmlDocument.createFromPlainText(value) Creates an HTML document from plain text. Return Type: HtmlDocument An HTML document with a body that contains the original plain text, without original indentation, but with line breaks. value - Type: String - The string containing the plain text. |
| new | HtmlDocument.new(value) Returns a new instance of HtmlDocument. Return Type: HtmlDocument value - Type: StreamData - The binary stream containing the HTML formatted data. |
Instance members
| Name | Description |
|---|---|
| getBodyAsXmlElement | instance.getBodyAsXmlElement Returns the body element in this document as an XML-element. Return Type: XmlNode An XmlNode instance representing the body element in the HTML document, or null if no body element was found. |
| getBodyInnerHtml | instance.getBodyInnerHtml Returns the contents of the body element in this document as a string. Return Type: String A string representing the contents of the body element in the HTML document, or null if no body element was found. |
| getStream | instance.getStream Gets the HTML document as binary stream data. Return Type: StreamData A StreamData instance containing binary data representing the HTML document. |
| toPlainText | instance.toPlainText Converts the HTML document to plain text. Return Type: String A string containing the text from the HTML document, but without the original formatting. |
HttpStatusCode type
The HttpStatusCode type exposes the following members.
Type members
| Name | Description |
|---|---|
| __100Continue | HttpStatusCode.__100Continue Return Type: HttpStatusCode |
| __101SwitchingProtocols | HttpStatusCode.__101SwitchingProtocols Return Type: HttpStatusCode |
| __200OK | HttpStatusCode.__200OK Return Type: HttpStatusCode |
| __201Created | HttpStatusCode.__201Created Return Type: HttpStatusCode |
| __202Accepted | HttpStatusCode.__202Accepted Return Type: HttpStatusCode |
| __203Non_AuthoritativeInformation | HttpStatusCode.__203Non_AuthoritativeInformation Return Type: HttpStatusCode |
| __204NoContent | HttpStatusCode.__204NoContent Return Type: HttpStatusCode |
| __205ResetContent | HttpStatusCode.__205ResetContent Return Type: HttpStatusCode |
| __206PartialContent | HttpStatusCode.__206PartialContent Return Type: HttpStatusCode |
| __207MultiStatus | HttpStatusCode.__207MultiStatus Return Type: HttpStatusCode |
| __300MultipleChoices | HttpStatusCode.__300MultipleChoices Return Type: HttpStatusCode |
| __301MovedPermanently | HttpStatusCode.__301MovedPermanently Return Type: HttpStatusCode |
| __302Found | HttpStatusCode.__302Found Return Type: HttpStatusCode |
| __303SeeOther | HttpStatusCode.__303SeeOther Return Type: HttpStatusCode |
| __304NotModified | HttpStatusCode.__304NotModified Return Type: HttpStatusCode |
| __305UseProxy | HttpStatusCode.__305UseProxy Return Type: HttpStatusCode |
| __307TemporaryRedirect | HttpStatusCode.__307TemporaryRedirect Return Type: HttpStatusCode |
| __400BadRequest | HttpStatusCode.__400BadRequest Return Type: HttpStatusCode |
| __401Unauthorized | HttpStatusCode.__401Unauthorized Return Type: HttpStatusCode |
| __402PaymentRequired | HttpStatusCode.__402PaymentRequired Return Type: HttpStatusCode |
| __403Forbidden | HttpStatusCode.__403Forbidden Return Type: HttpStatusCode |
| __404NotFound | HttpStatusCode.__404NotFound Return Type: HttpStatusCode |
| __405MethodNotAllowed | HttpStatusCode.__405MethodNotAllowed Return Type: HttpStatusCode |
| __406NotAcceptable | HttpStatusCode.__406NotAcceptable Return Type: HttpStatusCode |
| __407ProxyAuthenticationRequired | HttpStatusCode.__407ProxyAuthenticationRequired Return Type: HttpStatusCode |
| __408RequestTimeout | HttpStatusCode.__408RequestTimeout Return Type: HttpStatusCode |
| __409Conflict | HttpStatusCode.__409Conflict Return Type: HttpStatusCode |
| __410Gone | HttpStatusCode.__410Gone Return Type: HttpStatusCode |
| __411LengthRequired | HttpStatusCode.__411LengthRequired Return Type: HttpStatusCode |
| __412PreconditionFailed | HttpStatusCode.__412PreconditionFailed Return Type: HttpStatusCode |
| __413PayloadTooLarge | HttpStatusCode.__413PayloadTooLarge Return Type: HttpStatusCode |
| __414URITooLong | HttpStatusCode.__414URITooLong Return Type: HttpStatusCode |
| __415UnsupportedMediaType | HttpStatusCode.__415UnsupportedMediaType Return Type: HttpStatusCode |
| __500InternalServerError | HttpStatusCode.__500InternalServerError Return Type: HttpStatusCode |
| __501NotImplemented | HttpStatusCode.__501NotImplemented Return Type: HttpStatusCode |
| __502BadGateway | HttpStatusCode.__502BadGateway Return Type: HttpStatusCode |
| __503ServiceUnavailable | HttpStatusCode.__503ServiceUnavailable Return Type: HttpStatusCode |
| __504GatewayTimeout | HttpStatusCode.__504GatewayTimeout Return Type: HttpStatusCode |
| __505HTTPVersionNotSupported | HttpStatusCode.__505HTTPVersionNotSupported Return Type: HttpStatusCode |
| fromInteger | HttpStatusCode.fromInteger(value) Return Type: HttpStatusCode value - Type: Integer |
Integer type
Represents a 32-bit signed integer, with values ranging from negative 2,147,483,648 through positive 2,147,483,647. The Integer type exposes the following members.
Instance members
| Name | Description |
|---|---|
| abs | instance.abs Returns the absolute value of the number. The absolute value of a number is the number without its sign. Return Type: Integer |
| sqrt | instance.sqrt Returns a positive square root of the number. Return Type: Real |
| toReal | instance.toReal Converts the 32 bit integer value to a real-point value. Return Type: Real A real-point value based on the 32 bit integer value. |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| toString | instance.toString(format, culture) Converts the value to its equivalent string representation using the specified format and culture-specific format information. Return Type: String The string representation of the value as specified by format and provider. format - Type: String - A numeric format string. For more details, see the MSDN articles "Standard Numeric Format Strings" (http://msdn.microsoft.com/library/dwhawy9k) and "Custom Numeric Format Strings" (http://msdn.microsoft.com/library/0c899ak8). culture - Type: String - The culture name. A NULL value or empty string is interpreted as InvariantCulture, while a single dash "-" is interpreted as CurrentCulture. Otherwise, the value indicates the name of a culture. culture is not case-sensitive. For a list of predefined culture names, see the National Language Support (NLS) API Reference (http://go.microsoft.com/fwlink/?LinkId=200048). |
IntegerCounterDomain type
Used to assign a unique identifier to an object. Generates a unique numeric identifier which is incremented by one each time an identifier is assigned to an object. The IntegerCounterDomain type exposes the following members.
Type members
| Name | Description |
|---|---|
| lastUsedIdentifier | IntegerCounterDomain.lastUsedIdentifier Returns the last used identifier. Return Type: Integer |
| lastUsedIdentifier | IntegerCounterDomain.lastUsedIdentifier(filterObject) Returns the last used identifier. Return Type: Integer filterObject - Type: ObjectDomain - An object which indicates the counter to use. Applies to counter domains containing multiple counters, where each counter is uniquely identified by a primary key. |
| newIdentifier | IntegerCounterDomain.newIdentifier Reserves and returns the next available identifier. Return Type: Integer |
| newIdentifier | IntegerCounterDomain.newIdentifier(filterObject) Reserves and returns the next available identifier. Return Type: Integer filterObject - Type: ObjectDomain - An object which indicates the counter to use. Applies to counter domains containing multiple counters, where each counter is uniquely identified by a primary key. |
IntegerDate type
Represents an instant in time (year, month and day), using an integer on the form YYYYMMDD. The actual date's month and day part may be optional. E.g. the integer value 19750608 represents the date 8 June 1975. The IntegerDate type exposes the following members.
Type members
| Name | Description |
|---|---|
| new | IntegerDate.new(year, month, day) Return Type: IntegerDate year - Type: Integer month - Type: Integer day - Type: Integer |
| now | IntegerDate.now Return Type: IntegerDate |
| utcNow | IntegerDate.utcNow Return Type: IntegerDate |
Instance members
| Name | Description |
|---|---|
| addDays | instance.addDays(value) Return Type: IntegerDate value - Type: Integer |
| addMonths | instance.addMonths(value) Return Type: IntegerDate value - Type: Integer |
| addYears | instance.addYears(value) Return Type: IntegerDate value - Type: Integer |
| day | instance.day Return Type: Integer |
| month | instance.month Return Type: Integer |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| year | instance.year Return Type: Integer |
IntegerIdentifierDomain type
Used to assign a unique identifier to an object. Contains a finite set of identifiers. The IntegerIdentifierDomain type exposes the following members.
Type members
| Name | Description |
|---|---|
| newIdentifier | IntegerIdentifierDomain.newIdentifier Reserves and returns the next available identifier. Return Type: Integer |
IntegerTime type
Represents an instant in time, expressed as the hour and minute of the day, using an integer on the form HHMM. E.g. the integer value 1356 represents the time of 1:56 PM. The IntegerTime type exposes the following members.
Type members
| Name | Description |
|---|---|
| new | IntegerTime.new(hour, minute) Return Type: IntegerTime hour - Type: Integer minute - Type: Integer |
| now | IntegerTime.now Return Type: IntegerTime |
| utcNow | IntegerTime.utcNow Return Type: IntegerTime |
Instance members
| Name | Description |
|---|---|
| addHours | instance.addHours(value) Return Type: IntegerTime value - Type: Integer |
| addMinutes | instance.addMinutes(value) Return Type: IntegerTime value - Type: Integer |
| hour | instance.hour Return Type: Integer |
| minute | instance.minute Return Type: Integer |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
LargeInteger type
Represents a 64-bit signed integer, with values ranging from negative 9,223,372,036,854,775,808 through positive 9,223,372,036,854,775,807. The LargeInteger type exposes the following members.
Instance members
| Name | Description |
|---|---|
| toInteger | instance.toInteger Converts the 64 bit integer value to a 32 bit integer. Return Type: Integer A 32 bit integer value or null if the 64 bit integer was not successfully converted to a 32 bit integer. |
| toReal | instance.toReal Converts the 64 bit integer value to a real-point value. Return Type: Real A real-point value based on the 64 bit integer value. |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| toString | instance.toString(format, culture) Converts the value to its equivalent string representation using the specified format and culture-specific format information. Return Type: String The string representation of the value as specified by format and provider. format - Type: String - A numeric format string. For more details, see the MSDN articles "Standard Numeric Format Strings" (http://msdn.microsoft.com/library/dwhawy9k) and "Custom Numeric Format Strings" (http://msdn.microsoft.com/library/0c899ak8). culture - Type: String - The culture name. A NULL value or empty string is interpreted as InvariantCulture, while a single dash "-" is interpreted as CurrentCulture. Otherwise, the value indicates the name of a culture. culture is not case-sensitive. For a list of predefined culture names, see the National Language Support (NLS) API Reference (http://go.microsoft.com/fwlink/?LinkId=200048). |
MailAddressee type
The MailAddressee type exposes the following members.
Instance members
| Name | Description |
|---|---|
| displayName | instance.displayName Return Type: String |
| mailAddress | instance.mailAddress Return Type: String |
| mailAddressFormat | instance.mailAddressFormat Return Type: AddressFormat |
MailMessage type
The MailMessage type exposes the following members.
Instance members
| Name | Description |
|---|---|
| attachments | instance.attachments Return Type: Bag(GeneralFile) |
| bcc | instance.bcc Return Type: Bag(MailAddressee) |
| cc | instance.cc Return Type: Bag(MailAddressee) |
| contentID | instance.contentID Return Type: Guid |
| deliveryReceipt | instance.deliveryReceipt Return Type: Boolean |
| file | instance.file Return Type: GeneralFile |
| from | instance.from Return Type: MailAddressee |
| importance | instance.importance Return Type: MessageImportance |
| messageBody | instance.messageBody Return Type: String |
| messageBody_PlainText | instance.messageBody_PlainText Return Type: String |
| messageBodyFormat | instance.messageBodyFormat Return Type: MessageBodyFormat |
| read | instance.read Return Type: Boolean |
| readReceipt | instance.readReceipt Return Type: Boolean |
| received | instance.received Return Type: CalendarTime |
| replyTo | instance.replyTo Return Type: MailAddressee |
| sensitivity | instance.sensitivity Return Type: MessageSensitivity |
| sent | instance.sent Return Type: CalendarTime |
| subject | instance.subject Return Type: String |
| to | instance.to Return Type: Bag(MailAddressee) |
Math type
The Math type exposes the following members.
Type members
| Name | Description |
|---|---|
| abs | Math.abs(value) Returns the absolute value of a number. The absolute value of a number is the number without its sign. Return Type: Integer value - Type: Integer - The number of which you want the absolute value. |
| abs | Math.abs(value) Returns the absolute value of a number. The absolute value of a number is the number without its sign. Return Type: Real value - Type: Real - The number of which you want the absolute value. |
| ceiling | Math.ceiling(number) Returns the smallest whole number (64 bit integer) greater than or equal to the specified number. Return Type: LargeInteger The smallest whole number (64 bit integer) greater than or equal to number. number - Type: Real - A number. |
| ceilingInteger | Math.ceilingInteger(number) Returns the smallest whole number (32 bit integer) greater than or equal to the specified number. WARNING: Please consider potential integer overflow. Return Type: Integer The smallest whole number (32 bit integer) greater than or equal to number. number - Type: Real - A number. |
| e | Math.e Represents the natural logarithmic base, specified by the constant, e. Return Type: Real |
| evaluate | Math.evaluate(expression) Evaluates a string as a mathematical expression. Return Type: Real expression - Type: String - The expression that should be evaluated. |
| exp | Math.exp(number) Returns e raised to the specified power. Return Type: Real The number e raised to the power number. number - Type: Real - The exponent applied to the base e. |
| floor | Math.floor(number) Returns the largest whole number (64 bit integer) less than or equal to the specified number. Return Type: LargeInteger The largest whole number (64 bit integer) less than or equal to number. number - Type: Real - A number. |
| floorInteger | Math.floorInteger(number) Returns the largest whole number (32 bit integer) less than or equal to the specified number. WARNING: Please consider potential integer overflow. Return Type: Integer The largest whole number (32 bit integer) less than or equal to number. number - Type: Real - A number. |
| ln | Math.ln(number) Returns the natural logarithm of a number. Natural logarithms are based on the constant e (2.71828182845904). Return Type: Real number - Type: Real - The positive real number for which you want the natural logarithm. |
| log | Math.log(number [, base]) Returns the logarithm of a number to the base you specify. Return Type: Real number - Type: Real - The positive real number for which you want the logarithm. base (Optional) - Type: Real - The base of the logarithm. If base is omitted, it is assumed to be 10. |
| log10 | Math.log10(number) Returns the base-10 logarithm of a number. Return Type: Real number - Type: Real - The positive real number for which you want the base-10 logarithm. |
| pi | Math.pi Returns the ratio of the circumference of a circle to its diameter, specified by the constant PI. Return Type: Real |
| power | Math.power(number, power) Returns a specified number raised to the specified power. Return Type: Real number - Type: Real - The base number. power - Type: Real - The exponent to which the base number is raised. |
| round | Math.round(number [, numDigits]) Rounds a number to a specified number of decimal places. Return Type: Real number - Type: Real - The number you want to round. numDigits (Optional) - Type: Integer - Specifies the number of decimal places to which you want to round number. |
| roundDown | Math.roundDown(number [, numDigits]) Rounds a number down, toward zero. Return Type: Real number - Type: Real - The number you want to round. numDigits (Optional) - Type: Integer - Specifies the number of decimal places to which you want to round number. |
| roundHalfToEven | Math.roundHalfToEven(number [, numDigits]) Rounds a number to a specified number of decimal places, but such that 0.5 is rounded to the closest even integer number. Return Type: Real number - Type: Real - The number you want to round. numDigits (Optional) - Type: Integer - Specifies the number of decimal places to which you want to round number. |
| roundUp | Math.roundUp(number [, numDigits]) Rounds a number up, away from zero. Return Type: Real number - Type: Real - The number you want to round. numDigits (Optional) - Type: Integer - Specifies the number of decimal places to which you want to round number. |
| sqrt | Math.sqrt(number) Returns a positive square root. Return Type: Real number - Type: Real - A number. |
MessageAttachmentType enumeration
The MessageAttachmentType enumeration exposes the following members.
| Name | Description |
|---|---|
| file | MessageAttachmentType.file |
| message | MessageAttachmentType.message |
| oLEObject | MessageAttachmentType.oLEObject |
MessageBodyFormat enumeration
The MessageBodyFormat enumeration exposes the following members.
| Name | Description |
|---|---|
| hTML | MessageBodyFormat.hTML |
| mHTML_URL | MessageBodyFormat.mHTML_URL |
| plainText | MessageBodyFormat.plainText |
| rTF | MessageBodyFormat.rTF |
MessageImportance enumeration
The MessageImportance enumeration exposes the following members.
| Name | Description |
|---|---|
| high | MessageImportance.high |
| low | MessageImportance.low |
| normal | MessageImportance.normal |
MessageSensitivity enumeration
The MessageSensitivity enumeration exposes the following members.
| Name | Description |
|---|---|
| confidential | MessageSensitivity.confidential |
| normal | MessageSensitivity.normal |
| personal | MessageSensitivity.personal |
| private | MessageSensitivity.private |
MicrosoftProject type
The MicrosoftProject type exposes the following members.
Instance members
| Name | Description |
|---|---|
| file | instance.file Return Type: GeneralFile |
| finish | instance.finish Return Type: CalendarTime |
| notes | instance.notes Return Type: String |
| start | instance.start Return Type: CalendarTime |
| tasks | instance.tasks Return Type: Bag(Task) |
Month type
The Month type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | Month.fromCalendarTime(value) Return Type: Month value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| endDate | instance.endDate Return Type: CalendarTime |
| id | instance.id Return Type: CalendarTime |
| monthAndYearName | instance.monthAndYearName Return Type: String |
| monthName | instance.monthName Return Type: String |
| monthNumber | instance.monthNumber Return Type: Integer |
| monthShortName | instance.monthShortName Return Type: String |
| periodType | instance.periodType Return Type: Integer |
| startDate | instance.startDate Return Type: CalendarTime |
| yearNumber | instance.yearNumber Return Type: Integer |
NaturalLanguage enumeration
The NaturalLanguage enumeration exposes the following members.
| Name | Description |
|---|---|
| afrikaans_SouthAfrica | NaturalLanguage.afrikaans_SouthAfrica |
| albanian_Albania | NaturalLanguage.albanian_Albania |
| armenian_Armenia | NaturalLanguage.armenian_Armenia |
| azeri_Azerbaijan_Cyrillic | NaturalLanguage.azeri_Azerbaijan_Cyrillic |
| azeri_Azerbaijan_Latin | NaturalLanguage.azeri_Azerbaijan_Latin |
| basque_Basque | NaturalLanguage.basque_Basque |
| belarusian_Belarus | NaturalLanguage.belarusian_Belarus |
| bulgarian_Bulgaria | NaturalLanguage.bulgarian_Bulgaria |
| catalan_Catalan | NaturalLanguage.catalan_Catalan |
| chinese_HongKongSAR_PRC | NaturalLanguage.chinese_HongKongSAR_PRC |
| chinese_MacaoSAR | NaturalLanguage.chinese_MacaoSAR |
| chinese_PRC | NaturalLanguage.chinese_PRC |
| chinese_Simplified | NaturalLanguage.chinese_Simplified |
| chinese_Singapore | NaturalLanguage.chinese_Singapore |
| chinese_Taiwan | NaturalLanguage.chinese_Taiwan |
| chinese_Traditional | NaturalLanguage.chinese_Traditional |
| croatian_Croatia | NaturalLanguage.croatian_Croatia |
| czech_CzechRepublic | NaturalLanguage.czech_CzechRepublic |
| danish_Denmark | NaturalLanguage.danish_Denmark |
| dutch_Belgium | NaturalLanguage.dutch_Belgium |
| dutch_Netherlands | NaturalLanguage.dutch_Netherlands |
| english_Australia | NaturalLanguage.english_Australia |
| english_Belize | NaturalLanguage.english_Belize |
| english_Canada | NaturalLanguage.english_Canada |
| english_Caribbean | NaturalLanguage.english_Caribbean |
| english_Ireland | NaturalLanguage.english_Ireland |
| english_Jamaica | NaturalLanguage.english_Jamaica |
| english_NewZealand | NaturalLanguage.english_NewZealand |
| english_Philippines | NaturalLanguage.english_Philippines |
| english_SouthAfrica | NaturalLanguage.english_SouthAfrica |
| english_TrinidadAndTobago | NaturalLanguage.english_TrinidadAndTobago |
| english_UnitedKingdom | NaturalLanguage.english_UnitedKingdom |
| english_UnitedStates | NaturalLanguage.english_UnitedStates |
| english_Zimbabwe | NaturalLanguage.english_Zimbabwe |
| estonian_Estonia | NaturalLanguage.estonian_Estonia |
| faroese_FaroeIslands | NaturalLanguage.faroese_FaroeIslands |
| finnish_Finland | NaturalLanguage.finnish_Finland |
| french_Belgium | NaturalLanguage.french_Belgium |
| french_Canada | NaturalLanguage.french_Canada |
| french_France | NaturalLanguage.french_France |
| french_Luxembourg | NaturalLanguage.french_Luxembourg |
| french_Monaco | NaturalLanguage.french_Monaco |
| french_Switzerland | NaturalLanguage.french_Switzerland |
| galician_Spain | NaturalLanguage.galician_Spain |
| georgian_Georgia | NaturalLanguage.georgian_Georgia |
| german_Austria | NaturalLanguage.german_Austria |
| german_Germany | NaturalLanguage.german_Germany |
| german_Liechtenstein | NaturalLanguage.german_Liechtenstein |
| german_Luxembourg | NaturalLanguage.german_Luxembourg |
| german_Switzerland | NaturalLanguage.german_Switzerland |
| greek_Greece | NaturalLanguage.greek_Greece |
| gujarati_India | NaturalLanguage.gujarati_India |
| hindi_India | NaturalLanguage.hindi_India |
| hungarian_Hungary | NaturalLanguage.hungarian_Hungary |
| icelandic_Iceland | NaturalLanguage.icelandic_Iceland |
| indonesian_Indonesia | NaturalLanguage.indonesian_Indonesia |
| italian_Italy | NaturalLanguage.italian_Italy |
| italian_Switzerland | NaturalLanguage.italian_Switzerland |
| japanese_Japan | NaturalLanguage.japanese_Japan |
| kannada_India | NaturalLanguage.kannada_India |
| kazakh_Kazakhstan | NaturalLanguage.kazakh_Kazakhstan |
| konkani_India | NaturalLanguage.konkani_India |
| korean_Korea | NaturalLanguage.korean_Korea |
| kyrgyz_Kyrgyzstan | NaturalLanguage.kyrgyz_Kyrgyzstan |
| latvian_Latvia | NaturalLanguage.latvian_Latvia |
| lithuanian_Lithuania | NaturalLanguage.lithuanian_Lithuania |
| macedonian_Macedonia_FYROM | NaturalLanguage.macedonian_Macedonia_FYROM |
| malay_BruneiDarussalam | NaturalLanguage.malay_BruneiDarussalam |
| malay_Malaysia | NaturalLanguage.malay_Malaysia |
| marathi_India | NaturalLanguage.marathi_India |
| mongolian_Mongolia | NaturalLanguage.mongolian_Mongolia |
| norwegian_Bokmål_Norway | NaturalLanguage.norwegian_Bokmål_Norway |
| norwegian_Nynorsk_Norway | NaturalLanguage.norwegian_Nynorsk_Norway |
| polish_Poland | NaturalLanguage.polish_Poland |
| portuguese_Brazil | NaturalLanguage.portuguese_Brazil |
| portuguese_Portugal | NaturalLanguage.portuguese_Portugal |
| punjabi_India | NaturalLanguage.punjabi_India |
| romanian_Romania | NaturalLanguage.romanian_Romania |
| russian_Russia | NaturalLanguage.russian_Russia |
| sanskrit_India | NaturalLanguage.sanskrit_India |
| serbian_Serbia_Cyrillic | NaturalLanguage.serbian_Serbia_Cyrillic |
| serbian_Serbia_Latin | NaturalLanguage.serbian_Serbia_Latin |
| slovak_Slovakia | NaturalLanguage.slovak_Slovakia |
| slovenian_Slovenia | NaturalLanguage.slovenian_Slovenia |
| spanish_Argentina | NaturalLanguage.spanish_Argentina |
| spanish_Bolivia | NaturalLanguage.spanish_Bolivia |
| spanish_Chile | NaturalLanguage.spanish_Chile |
| spanish_Colombia | NaturalLanguage.spanish_Colombia |
| spanish_CostaRica | NaturalLanguage.spanish_CostaRica |
| spanish_DominicanRepublic | NaturalLanguage.spanish_DominicanRepublic |
| spanish_Ecuador | NaturalLanguage.spanish_Ecuador |
| spanish_ElSalvador | NaturalLanguage.spanish_ElSalvador |
| spanish_Guatemala | NaturalLanguage.spanish_Guatemala |
| spanish_Honduras | NaturalLanguage.spanish_Honduras |
| spanish_Mexico | NaturalLanguage.spanish_Mexico |
| spanish_Nicaragua | NaturalLanguage.spanish_Nicaragua |
| spanish_Panama | NaturalLanguage.spanish_Panama |
| spanish_Paraguay | NaturalLanguage.spanish_Paraguay |
| spanish_Peru | NaturalLanguage.spanish_Peru |
| spanish_PuertoRico | NaturalLanguage.spanish_PuertoRico |
| spanish_Spain | NaturalLanguage.spanish_Spain |
| spanish_Spain_TraditionalSort | NaturalLanguage.spanish_Spain_TraditionalSort |
| spanish_Uruguay | NaturalLanguage.spanish_Uruguay |
| spanish_Venezuela | NaturalLanguage.spanish_Venezuela |
| swahili_Kenya | NaturalLanguage.swahili_Kenya |
| swedish_Finland | NaturalLanguage.swedish_Finland |
| swedish_Sweden | NaturalLanguage.swedish_Sweden |
| tamil_India | NaturalLanguage.tamil_India |
| tatar_Russia | NaturalLanguage.tatar_Russia |
| telugu_India | NaturalLanguage.telugu_India |
| thai_Thailand | NaturalLanguage.thai_Thailand |
| turkish_Turkey | NaturalLanguage.turkish_Turkey |
| ukrainian_Ukraine | NaturalLanguage.ukrainian_Ukraine |
| uzbek_Uzbekistan_Cyrillic | NaturalLanguage.uzbek_Uzbekistan_Cyrillic |
| uzbek_Uzbekistan_Latin | NaturalLanguage.uzbek_Uzbekistan_Latin |
| vietnamese_Vietnam | NaturalLanguage.vietnamese_Vietnam |
Object type
This is the ultimate base class of all classes; it is the root of the type hierarchy. Because all classes are derived from this class, every function defined here is also available all classes.
OrderedSet(<ElementType>) type
The OrderedSet(<ElementType>) type exposes the following members.
Instance members
| Name | Description |
|---|---|
| append | instance.append(object) Return Type: OrderedSet(<ElementType>) object - Type: <ElementType> |
| asBag | instance.asBag Return Type: Bag(<ElementType>) |
| asOrderedSet | instance.asOrderedSet Return Type: OrderedSet(<ElementType>) |
| asSequence | instance.asSequence Return Type: Sequence(<ElementType>) |
| asSet | instance.asSet Return Type: Set(<ElementType>) |
| count | instance.count Return Type: Integer |
| count | instance.count(object) Return Type: Integer object - Type: <ElementType> |
| emptyIfNull | instance.emptyIfNull Returns the empty collection if the instance is null; otherwise, the instance is returned. Return Type: OrderedSet(<ElementType>) |
| excludes | instance.excludes(object) Return Type: Boolean object - Type: <ElementType> |
| excludesAll | instance.excludesAll(c2) Return Type: Boolean c2 - Type: Collection(<ElementType>) |
| excluding | instance.excluding(object) Return Type: OrderedSet(<ElementType>) object - Type: <ElementType> |
| exists | instance.exists(<iterator expression>) Returns TRUE if at least one Collection(<ElementType>) instance match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| first | instance.first Returns the first element of an ordered set, and throws an exception if the ordered set contains no elements. To instead return a default value when the ordered set is empty, use FirstOrDefault. Return Type: <ElementType> |
| firstOrDefault | instance.firstOrDefault Returns the first element of an ordered set, or a default value if the ordered set contains no elements. Return Type: <ElementType> |
| flatten | instance.flatten Return Type: OrderedSet(<ElementType>) |
| flattenRecursive | instance.flattenRecursive Return Type: OrderedSet(<ElementType>) |
| forAll | instance.forAll(<iterator expression>) Returns TRUE if all Collection(<ElementType>) instances match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| includes | instance.includes(object) Return Type: Boolean object - Type: <ElementType> |
| includesAll | instance.includesAll(c2) Return Type: Boolean c2 - Type: Collection(<ElementType>) |
| including | instance.including(object) Return Type: OrderedSet(<ElementType>) object - Type: <ElementType> |
| isEmpty | instance.isEmpty Return Type: Boolean |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: OrderedSet(<ElementType>) joinWith - Type: Collection(Object) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: OrderedSet(<ElementType>) joinWith - Type: Collection(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| last | instance.last Returns the last element of a ordered set, and throws an exception if the ordered set contains no elements. To instead return a default value when the ordered set is empty, use LastOrDefault. Return Type: <ElementType> |
| lastOrDefault | instance.lastOrDefault Returns the last element of an ordered set, or a default value if the ordered set contains no elements. Return Type: <ElementType> |
| notEmpty | instance.notEmpty Return Type: Boolean |
| prepend | instance.prepend(object) Return Type: OrderedSet(<ElementType>) object - Type: <ElementType> |
| reject | instance.reject(<iterator expression>) Removes all instances of <ElementType> that match the <iterator expression>. Return Type: OrderedSet(<ElementType>) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| select | instance.select(<iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: OrderedSet(<ElementType>) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| single | instance.single Returns the only element of a collection, and throws an exception if there is not exactly one element in the collection. To instead return a default value when the collection is empty, use SingleOrDefault. Return Type: <ElementType> |
| singleOrDefault | instance.singleOrDefault Returns the only element of a collection, or a default value if the collection is empty. An exception is thrown if there is more than one element in the collection. Return Type: <ElementType> |
OrderedSet(Value) type
The OrderedSet(Value) type exposes the following members.
Instance members
| Name | Description |
|---|---|
| append | instance.append(object) Return Type: OrderedSet(Value) object - Type: Value |
| emptyIfNull | instance.emptyIfNull Returns the empty collection if the instance is null; otherwise, the instance is returned. Return Type: OrderedSet(Value) |
| excluding | instance.excluding(object) Return Type: OrderedSet(Value) object - Type: Value |
| first | instance.first Returns the first element of an ordered set, and throws an exception if the ordered set contains no elements. To instead return a default value when the ordered set is empty, use FirstOrDefault. Return Type: Value |
| firstOrDefault | instance.firstOrDefault Returns the first element of an ordered set, or a default value if the ordered set contains no elements. Return Type: Value |
| flatten | instance.flatten Return Type: OrderedSet(Value) |
| flattenRecursive | instance.flattenRecursive Return Type: OrderedSet(Value) |
| including | instance.including(object) Return Type: OrderedSet(Value) object - Type: Value |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of Value that match the <iterator expression>. Return Type: OrderedSet(Value) joinWith - Type: Collection(Object) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Value. |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of Value that match the <iterator expression>. Return Type: OrderedSet(Value) joinWith - Type: Collection(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Value. |
| last | instance.last Returns the last element of a ordered set, and throws an exception if the ordered set contains no elements. To instead return a default value when the ordered set is empty, use LastOrDefault. Return Type: Value |
| lastOrDefault | instance.lastOrDefault Returns the last element of an ordered set, or a default value if the ordered set contains no elements. Return Type: Value |
| prepend | instance.prepend(object) Return Type: OrderedSet(Value) object - Type: Value |
| reject | instance.reject(<iterator expression>) Removes all instances of Value that match the <iterator expression>. Return Type: OrderedSet(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Value. |
| select | instance.select(<iterator expression>) Selects only those instances of Value that match the <iterator expression>. Return Type: OrderedSet(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Value. |
| sort | instance.sort(ascending) Return Type: OrderedSet(Value) ascending - Type: Boolean |
| toString | instance.toString Returns a string representation of the values. Return Type: String |
PrintSettings type
The PrintSettings type exposes the following members.
Instance members
| Name | Description |
|---|---|
| collate | instance.collate Return Type: Boolean |
| identifier | instance.identifier Return Type: Guid |
| numberOfCopies | instance.numberOfCopies Return Type: Integer |
| paperSource | instance.paperSource Return Type: String |
| printer | instance.printer Return Type: String |
Quarter type
The Quarter type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | Quarter.fromCalendarTime(value) Return Type: Quarter value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| endDate | instance.endDate Return Type: CalendarTime |
| id | instance.id Return Type: CalendarTime |
| periodType | instance.periodType Return Type: Integer |
| quarterAndYearName | instance.quarterAndYearName Return Type: String |
| quarterNumber | instance.quarterNumber Return Type: Integer |
| startDate | instance.startDate Return Type: CalendarTime |
| yearNumber | instance.yearNumber Return Type: Integer |
Real type
Represents a 64-bit double-precision real-point number with values ranging from negative 1.79769313486232e308 to positive 1.79769313486232e308. The Real type exposes the following members.
Instance members
| Name | Description |
|---|---|
| abs | instance.abs Returns the absolute value of the number. The absolute value of a number is the number without its sign. Return Type: Real |
| ceiling | instance.ceiling Returns the smallest whole number (64 bit integer) greater than or equal to this number. Return Type: LargeInteger The smallest whole number (64 bit integer) greater than or equal to this number. |
| ceilingInteger | instance.ceilingInteger Returns the smallest whole number (32 bit integer) greater than or equal to this number. WARNING: Please consider potential integer overflow. Return Type: Integer The smallest whole number (32 bit integer) greater than or equal to this number. |
| floor | instance.floor Returns the largest whole number (64 bit integer) less than or equal to this number. Return Type: LargeInteger The largest whole number (64 bit integer) less than or equal to this number. |
| floorInteger | instance.floorInteger Returns the largest whole number (32 bit integer) less than or equal to this number. WARNING: Please consider potential integer overflow. Return Type: Integer The largest whole number (32 bit integer) less than or equal to this number. |
| log10 | instance.log10 Returns the base-10 logarithm of a number. Return Type: Real |
| round | instance.round([numDigits]) Rounds the number to a specified number of decimal places. Return Type: Real numDigits (Optional) - Type: Integer - Specifies the number of decimal places to which you want to round number. |
| roundDown | instance.roundDown([numDigits]) Rounds the number down, toward zero. Return Type: Real numDigits (Optional) - Type: Integer - Specifies the number of decimal places to which you want to round number. |
| roundHalfToEven | instance.roundHalfToEven([numDigits]) Rounds a number to a specified number of decimal places, but such that 0.5 is rounded to the closest even integer number. Return Type: Real numDigits (Optional) - Type: Integer - Specifies the number of decimal places to which you want to round number. |
| roundUp | instance.roundUp([numDigits]) Rounds the number down, toward zero. Return Type: Real numDigits (Optional) - Type: Integer - Specifies the number of decimal places to which you want to round number. |
| sqrt | instance.sqrt Returns a positive square root of the number. Return Type: Real |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| toString | instance.toString(format, culture) Converts the value to its equivalent string representation using the specified format and culture-specific format information. Return Type: String The string representation of the value as specified by format and provider. format - Type: String - A numeric format string. For more details, see the MSDN articles "Standard Numeric Format Strings" (http://msdn.microsoft.com/library/dwhawy9k) and "Custom Numeric Format Strings" (http://msdn.microsoft.com/library/0c899ak8). culture - Type: String - The culture name. A NULL value or empty string is interpreted as InvariantCulture, while a single dash "-" is interpreted as CurrentCulture. Otherwise, the value indicates the name of a culture. culture is not case-sensitive. For a list of predefined culture names, see the National Language Support (NLS) API Reference (http://go.microsoft.com/fwlink/?LinkId=200048). |
Regex type
Represents a regular expression. The Regex type exposes the following members.
Type members
| Name | Description |
|---|---|
| isMatch | Regex.isMatch(input, pattern) Indicates whether the regular expression finds a match in the input string using the regular expression specified in the pattern parameter. Return Type: Boolean TRUE if the regular expression finds a match; otherwise, FALSE. input - Type: String - The string to search for a match. pattern - Type: String - The regular expression pattern to match. |
| replace | Regex.replace(input, pattern, replaceMask) If the regular expression finds a match in the input string using the regular expression specified in the pattern parameter, the replace mask is used to return a parsed result string. Return Type: String a string with values based on the format mask, or empty if no match is found. input - Type: String - The string to search for a match. pattern - Type: String - The regular expression pattern to match. replaceMask - Type: String - The mask used to format the result. |
RichTextDocument type
Represents a Rich Text document (RTF). The RichTextDocument type exposes the following members.
Type members
| Name | Description |
|---|---|
| new | RichTextDocument.new(value) Returns a new instance of RichTextDocument. Return Type: RichTextDocument value - Type: StreamData - The binary stream containing the Rich Text formatted data. |
Instance members
| Name | Description |
|---|---|
| toPlainText | instance.toPlainText Converts the Rich Text document to plain text. Return Type: String A string containing the text from the Rich Text document, but without the original formatting. |
SecurityGroup type
The SecurityGroup type exposes the following members.
Instance members
| Name | Description |
|---|---|
| description | instance.description Return Type: String |
| identifier | instance.identifier Return Type: String |
| name | instance.name Return Type: String |
Sequence(<ElementType>) type
The Sequence(<ElementType>) type exposes the following members.
Instance members
| Name | Description |
|---|---|
| append | instance.append(object) Return Type: Sequence(<ElementType>) object - Type: <ElementType> |
| asBag | instance.asBag Return Type: Bag(<ElementType>) |
| asOrderedSet | instance.asOrderedSet Return Type: OrderedSet(<ElementType>) |
| asSequence | instance.asSequence Return Type: Sequence(<ElementType>) |
| asSet | instance.asSet Return Type: Set(<ElementType>) |
| count | instance.count Return Type: Integer |
| count | instance.count(object) Return Type: Integer object - Type: <ElementType> |
| emptyIfNull | instance.emptyIfNull Returns the empty collection if the instance is null; otherwise, the instance is returned. Return Type: Sequence(<ElementType>) |
| excludes | instance.excludes(object) Return Type: Boolean object - Type: <ElementType> |
| excludesAll | instance.excludesAll(c2) Return Type: Boolean c2 - Type: Collection(<ElementType>) |
| excluding | instance.excluding(object) Return Type: Sequence(<ElementType>) object - Type: <ElementType> |
| exists | instance.exists(<iterator expression>) Returns TRUE if at least one Collection(<ElementType>) instance match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| first | instance.first Returns the first element of a sequence, and throws an exception if the sequence contains no elements. To instead return a default value when the sequence is empty, use FirstOrDefault. Return Type: <ElementType> |
| firstOrDefault | instance.firstOrDefault Returns the first element of a sequence, or a default value if the sequence contains no elements. Return Type: <ElementType> |
| flatten | instance.flatten Return Type: Sequence(<ElementType>) |
| flattenRecursive | instance.flattenRecursive Return Type: Sequence(<ElementType>) |
| forAll | instance.forAll(<iterator expression>) Returns TRUE if all Collection(<ElementType>) instances match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| includes | instance.includes(object) Return Type: Boolean object - Type: <ElementType> |
| includesAll | instance.includesAll(c2) Return Type: Boolean c2 - Type: Collection(<ElementType>) |
| including | instance.including(object) Return Type: Sequence(<ElementType>) object - Type: <ElementType> |
| isEmpty | instance.isEmpty Return Type: Boolean |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Sequence(<ElementType>) joinWith - Type: Collection(Object) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Sequence(<ElementType>) joinWith - Type: Collection(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| last | instance.last Returns the last element of a sequence, and throws an exception if the sequence contains no elements. To instead return a default value when the sequence is empty, use LastOrDefault. Return Type: <ElementType> |
| lastOrDefault | instance.lastOrDefault Returns the last element of a sequence, or a default value if the sequence contains no elements. Return Type: <ElementType> |
| notEmpty | instance.notEmpty Return Type: Boolean |
| prepend | instance.prepend(object) Return Type: Sequence(<ElementType>) object - Type: <ElementType> |
| reject | instance.reject(<iterator expression>) Removes all instances of <ElementType> that match the <iterator expression>. Return Type: Sequence(<ElementType>) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| select | instance.select(<iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Sequence(<ElementType>) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| single | instance.single Returns the only element of a collection, and throws an exception if there is not exactly one element in the collection. To instead return a default value when the collection is empty, use SingleOrDefault. Return Type: <ElementType> |
| singleOrDefault | instance.singleOrDefault Returns the only element of a collection, or a default value if the collection is empty. An exception is thrown if there is more than one element in the collection. Return Type: <ElementType> |
Sequence(Value) type
The Sequence(Value) type exposes the following members.
Instance members
| Name | Description |
|---|---|
| append | instance.append(object) Return Type: Sequence(Value) object - Type: Value |
| emptyIfNull | instance.emptyIfNull Returns the empty collection if the instance is null; otherwise, the instance is returned. Return Type: Sequence(Value) |
| excluding | instance.excluding(object) Return Type: Sequence(Value) object - Type: Value |
| first | instance.first Returns the first element of a sequence, and throws an exception if the sequence contains no elements. To instead return a default value when the sequence is empty, use FirstOrDefault. Return Type: Value |
| firstOrDefault | instance.firstOrDefault Returns the first element of a sequence, or a default value if the sequence contains no elements. Return Type: Value |
| flatten | instance.flatten Return Type: Sequence(Value) |
| flattenRecursive | instance.flattenRecursive Return Type: Sequence(Value) |
| including | instance.including(object) Return Type: Sequence(Value) object - Type: Value |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of Value that match the <iterator expression>. Return Type: Sequence(Value) joinWith - Type: Collection(Object) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Value. |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of Value that match the <iterator expression>. Return Type: Sequence(Value) joinWith - Type: Collection(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Value. |
| last | instance.last Returns the last element of a sequence, and throws an exception if the sequence contains no elements. To instead return a default value when the sequence is empty, use LastOrDefault. Return Type: Value |
| lastOrDefault | instance.lastOrDefault Returns the last element of a sequence, or a default value if the sequence contains no elements. Return Type: Value |
| prepend | instance.prepend(object) Return Type: Sequence(Value) object - Type: Value |
| reject | instance.reject(<iterator expression>) Removes all instances of Value that match the <iterator expression>. Return Type: Sequence(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Value. |
| select | instance.select(<iterator expression>) Selects only those instances of Value that match the <iterator expression>. Return Type: Sequence(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type Value. |
| sort | instance.sort(ascending) Return Type: Sequence(Value) ascending - Type: Boolean |
| toString | instance.toString Returns a string representation of the values. Return Type: String |
Set(<ElementType>) type
The Set(<ElementType>) type exposes the following members.
Instance members
| Name | Description |
|---|---|
| asBag | instance.asBag Return Type: Bag(<ElementType>) |
| asOrderedSet | instance.asOrderedSet Return Type: OrderedSet(<ElementType>) |
| asSequence | instance.asSequence Return Type: Sequence(<ElementType>) |
| asSet | instance.asSet Return Type: Set(<ElementType>) |
| count | instance.count Return Type: Integer |
| count | instance.count(object) Return Type: Integer object - Type: <ElementType> |
| emptyIfNull | instance.emptyIfNull Returns the empty collection if the instance is null; otherwise, the instance is returned. Return Type: Set(<ElementType>) |
| excludes | instance.excludes(object) Return Type: Boolean object - Type: <ElementType> |
| excludesAll | instance.excludesAll(c2) Return Type: Boolean c2 - Type: Collection(<ElementType>) |
| excluding | instance.excluding(object) Return Type: Set(<ElementType>) object - Type: <ElementType> |
| exists | instance.exists(<iterator expression>) Returns TRUE if at least one Collection(<ElementType>) instance match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| flatten | instance.flatten Return Type: Set(<ElementType>) |
| flattenRecursive | instance.flattenRecursive Return Type: Set(<ElementType>) |
| forAll | instance.forAll(<iterator expression>) Returns TRUE if all Collection(<ElementType>) instances match the <iterator expression>, otherwise FALSE is returned. Return Type: Boolean <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| includes | instance.includes(object) Return Type: Boolean object - Type: <ElementType> |
| includesAll | instance.includesAll(c2) Return Type: Boolean c2 - Type: Collection(<ElementType>) |
| including | instance.including(object) Return Type: Set(<ElementType>) object - Type: <ElementType> |
| intersection | instance.intersection(b) Return Type: Set(<ElementType>) b - Type: Bag(<ElementType>) |
| intersection | instance.intersection(s) Return Type: Set(<ElementType>) s - Type: Set(<ElementType>) |
| isEmpty | instance.isEmpty Return Type: Boolean |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Set(<ElementType>) joinWith - Type: Collection(Object) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| join | instance.join(joinWith, <iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Set(<ElementType>) joinWith - Type: Collection(Value) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| minus | instance.minus(s) Return Type: Set(<ElementType>) s - Type: Set(<ElementType>) |
| notEmpty | instance.notEmpty Return Type: Boolean |
| reject | instance.reject(<iterator expression>) Removes all instances of <ElementType> that match the <iterator expression>. Return Type: Set(<ElementType>) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| select | instance.select(<iterator expression>) Selects only those instances of <ElementType> that match the <iterator expression>. Return Type: Set(<ElementType>) <iterator expression> - Type: <iterator expression> - An expression on the form "x | <some boolean expression using x>", where x is of type <ElementType>. |
| single | instance.single Returns the only element of a collection, and throws an exception if there is not exactly one element in the collection. To instead return a default value when the collection is empty, use SingleOrDefault. Return Type: <ElementType> |
| singleOrDefault | instance.singleOrDefault Returns the only element of a collection, or a default value if the collection is empty. An exception is thrown if there is more than one element in the collection. Return Type: <ElementType> |
| union | instance.union(b) Return Type: Bag(<ElementType>) b - Type: Bag(<ElementType>) |
| union | instance.union(s) Return Type: Set(<ElementType>) s - Type: Set(<ElementType>) |
SortOrder enumeration
The SortOrder enumeration exposes the following members.
| Name | Description |
|---|---|
| ascending | SortOrder.ascending |
| descending | SortOrder.descending |
Statistics type
The Statistics type exposes the following members.
Type members
| Name | Description |
|---|---|
| average | Statistics.average(values) Returns the average (arithmetic mean) of a collection of values. Return Type: CalendarTimeSpan values - Type: Collection(CalendarTimeSpan) - Values to be used for the calculation. |
| average | Statistics.average(values) Returns the average (arithmetic mean) of a collection of values. Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| count | Statistics.count(values) Returns the number of data values. Return Type: Integer values - Type: Collection(Real) - Values to be used for the calculation. |
| max | Statistics.max(values) Returns the largest value in a collection of values. Return Type: CalendarTimeSpan values - Type: Collection(CalendarTimeSpan) - Values to be used for the calculation. |
| max | Statistics.max(values) Returns the largest value in a collection of values. Return Type: Integer values - Type: Collection(Integer) - Values to be used for the calculation. |
| max | Statistics.max(values) Returns the largest value in a collection of values. Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| median | Statistics.median(values) Returns the median of the given values. The median is the value in the middle of a collection of values; that is, half the values are greater than the median, and half are less. Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| min | Statistics.min(values) Returns the smallest value in a collection of values. Return Type: CalendarTimeSpan values - Type: Collection(CalendarTimeSpan) - Values to be used for the calculation. |
| min | Statistics.min(values) Returns the smallest value in a collection of values. Return Type: Integer values - Type: Collection(Integer) - Values to be used for the calculation. |
| min | Statistics.min(values) Returns the smallest value in a collection of values. Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| norm | Statistics.norm(values) Returns the Euclidean "L-2" norm for the data values (the square root of the sum of squares). Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| percentileCont | Statistics.percentileCont(values, percentile, sortOrder) Returns the percentile based on a continuous distribution of the data values. The result is interpolated and might not be equal to any of the specific data values. Return Type: Real values - Type: Collection(Integer) - Values to be used for the calculation. percentile - Type: Real - The percentile to compute. The value must range between 0.0 and 1.0. sortOrder - Type: SortOrder - The order applied when data values are sorted (ascending or descending). |
| percentileCont | Statistics.percentileCont(values, percentile, sortOrder) Returns the percentile based on a continuous distribution of the data values. The result is interpolated and might not be equal to any of the specific data values. Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. percentile - Type: Real - The percentile to compute. The value must range between 0.0 and 1.0. sortOrder - Type: SortOrder - The order applied when data values are sorted (ascending or descending). |
| stdev | Statistics.stdev(values) Estimates standard deviation based on a sample. The standard deviation is a measure of how widely values are dispersed from the average value (the mean). Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| stdevp | Statistics.stdevp(values) Calculates standard deviation based on the entire population given as arguments. The standard deviation is a measure of how widely values are dispersed from the average value (the mean). Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| sum | Statistics.sum(values) Returns the sum of a collection of values. Return Type: CalendarTimeSpan values - Type: Collection(CalendarTimeSpan) - Values to be used for the calculation. |
| sum | Statistics.sum(values) Returns the sum of a collection of values. Return Type: Integer values - Type: Collection(Integer) - Values to be used for the calculation. |
| sum | Statistics.sum(values) Returns the sum of a collection of values. Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| sumsq | Statistics.sumsq(values) Returns the sum of the squares of a collection of values. Return Type: Integer values - Type: Collection(Integer) - Values to be used for the calculation. |
| sumsq | Statistics.sumsq(values) Returns the sum of the squares of a collection of values. Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| var | Statistics.var(values) Estimates variance based on a sample. Var assumes that its arguments are a sample of the population. If your data represents the entire population, then compute the variance using Varp. Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| varp | Statistics.varp(values) Calculates variance based on the entire population. Varp assumes that its arguments are the entire population. If your data represents a sample of the population, then compute the variance using Var. Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
| vart | Statistics.vart(values) Returns the sum of the squares of the difference between each data value and the mean of the data values. Return Type: Real values - Type: Collection(Real) - Values to be used for the calculation. |
StreamData type
Provides a generic view of a sequence of bytes. The StreamData type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromBase64String | StreamData.fromBase64String(value) Converts the specified string, which encodes binary data as base-64 digits, to an equivalent StreamData instance containing the decoded binary data. Return Type: StreamData value - Type: String - The string to convert. |
| fromBase64UrlString | StreamData.fromBase64UrlString(value) Converts the specified string, which encodes binary data as base-64 URL digits, to an equivalent StreamData instance containing the decoded binary data. Return Type: StreamData value - Type: String - A string that has been previously encoded as Base64URL. (Like base-64, except for special characters +, /, and =). |
| new | StreamData.new(value, encoding) Creates a new instance of the class encoding the specified string into a sequence of bytes. Return Type: StreamData value - Type: String - The string to be encoded. encoding - Type: Encoding - The encoding to be used to translate the string into a sequence of bytes. |
Instance members
| Name | Description |
|---|---|
| getString | instance.getString(encoding) Gets a string from this instance using the specified encoding. Return Type: String encoding - Type: Encoding - The encoding to be used to translate a sequence of bytes into a string. |
| size | instance.size Gets the size of the stream. Return Type: Integer |
| toBase64String | instance.toBase64String Converts the binary data to its equivalent string representation that is encoded with base-64 digits. Return Type: String |
| toBase64UrlString | instance.toBase64UrlString Converts the binary data to its equivalent string representation that is encoded with base-64 URL digits. (Like base-64, except for special characters +, /, and =). Return Type: String |
String type
A sequential collection of characters, typically used to represent text. The String type exposes the following members.
Type members
| Name | Description |
|---|---|
| createCompactGuidString | String.createCompactGuidString Creates a unique identifier. Return Type: String |
| join | String.join(separator, values, includeNullOrEmpty) Concatenates all the elements of a string collection, using the specified separator between each element. Return Type: String A string that consists of the elements of the string collection delimited by the specified separator string. If the string collection has no elements, the function returns the empty string. separator - Type: String - The string to use as a separator. This string is included in the returned string only if the collection has more than one element. values - Type: Collection(String) - A collection that contains the strings to concatenate. includeNullOrEmpty - Type: Boolean - TRUE to include even collection elements that are null or the empty string; otherwise, FALSE to exclude such elements before concatenation. |
| new | String.new([value]) Creates a new instance of the String class. Return Type: String value (Optional) - Type: String - A string of characters. |
Instance members
| Name | Description |
|---|---|
| containsAllWords | instance.containsAllWords(words [, matching]) Checks if the string contains all of the supplied words. Return Type: Boolean A boolean value indicating whether or not all the words were found in the string. words - Type: Collection(String) matching (Optional) - Type: TextMatching - Default Value: TextMatching.startsWith - The text matching method to be used. |
| containsAllWords | instance.containsAllWords(words [, matching]) Checks if the string contains all of the supplied words. Return Type: Boolean A boolean value indicating whether or not all the words were found in the string. words - Type: String matching (Optional) - Type: TextMatching - Default Value: TextMatching.startsWith - The text matching method to be used. |
| containsAnyWords | instance.containsAnyWords(words [, matching]) Checks if the string contains any of the supplied words. Return Type: Boolean A boolean value indicating whether or not any the words were found in the string. words - Type: Collection(String) matching (Optional) - Type: TextMatching - Default Value: TextMatching.startsWith - The text matching method to be used. |
| containsAnyWords | instance.containsAnyWords(words [, matching]) Checks if the string contains any of the supplied words. Return Type: Boolean A boolean value indicating whether or not any the words were found in the string. words - Type: String matching (Optional) - Type: TextMatching - Default Value: TextMatching.startsWith - The text matching method to be used. |
| containsNearWords | instance.containsNearWords(words [, maxSpan] [, ordered]) Checks if the string contains all of the supplied words within a range of the number of words specified by "maxSpan". Return Type: Boolean A boolean value indicating whether or not the words were found in the string. words - Type: Collection(String) - Collection of search terms. The order in which the search terms are specified will only have significance if specified by "ordered" and the collection of search terms is inherently ordered. maxSpan (Optional) - Type: Integer - Limits the smallest group of words in which all query terms occurs. The number of words in such a group may not exceed the specified value. ordered (Optional) - Type: Boolean - A boolean value indicating whether the words must be found in the order in which the search terms are specified. |
| containsNearWords | instance.containsNearWords(words [, maxSpan] [, ordered]) Checks if the string contains all of the supplied words within a range of the number of words specified by "maxSpan". Return Type: Boolean A boolean value indicating whether or not the words were found in the string. words - Type: String - The search terms separated by space. Double quotes may be used to group several words. (Double quote characters may need to be escaped with backslash (\)). maxSpan (Optional) - Type: Integer - Limits the smallest group of words in which all query terms occurs. The number of words in such a group may not exceed the specified value. ordered (Optional) - Type: Boolean - A boolean value indicating whether the words must be found in the order in which the search terms are specified. |
| containsWildcardText | instance.containsWildcardText(expression) Checks if the string contains text matching a wildcard expression. Return Type: Boolean A boolean value indicating whether the string matches the wildcard expression. expression - Type: String - Contains the text to search for and may include "?" and "*" wildcard charracters. "?" matches one arbitrary character whereas "*" matches any number (including 0) of characters. Examples: G?nus, G*us, Gen*. |
| indexOf | instance.indexOf(value) Reports the index of the first occurrence of the specified string in this string. Return Type: Integer The index position of value if that string is found, or -1 if it is not. If value is String.Empty, the return value is 0. value - Type: String - The string to search for. |
| insert | instance.insert(startIndex, value) Inserts a specified string at a specified index position in this string. Return Type: String A new string equivalent to this string but with value inserted at position startIndex. startIndex - Type: Integer - The index position of the insertion. value - Type: String - The string to insert. |
| length | instance.length Returns the number of characters in this string. Return Type: Integer |
| remove | instance.remove(startIndex, count) Deletes a specified number of characters from this string beginning at a specified position. Return Type: String A new string that is equivalent to this instance less count number of characters. startIndex - Type: Integer - The index position to begin deleting characters. count - Type: Integer - The number of characters to delete. |
| replace | instance.replace(oldValue, newValue) Replaces all occurrences of a specified string in this string, with another specified string. Return Type: String A new string equivalent to this string but with all instances of oldValue replaced with newValue. oldValue - Type: String - A string to be replaced. newValue - Type: String - A string to replace all occurrences of oldValue. |
| satisfies | instance.satisfies(searchString) Checks if the string contains values that match the supplied search string. Return Type: Boolean A boolean value indicating whether values that match the search string were found. searchString - Type: String |
| split | instance.split(separator [, includeEmpty]) Identifies the substrings in the current string that are delimited by one or more characters, and then returns the substrings in a sequence of strings. Return Type: Sequence(String) A sequence of strings. If the current string contains none of the characters specified in the separator argument, the function returns a sequence consisting of a single element that contains the current string. If no separator is given, the function returns a sequence of strings delimited by white-space characters. Note that an empty string is returned for any substring in which two delimiters are adjacent, or if a delimiter is found at the beginning or end of the current string. To omit empty strings, set the includeEmpty argument to FALSE. Delimiter characters are not included in the substrings. separator - Type: String - The string that delimit the substrings in the current string. includeEmpty (Optional) - Type: Boolean - Default Value: true - TRUE to include substrings that are empty, FALSE to omit empty substrings. |
| substring | instance.substring(startIndex [, length]) Returns a substring from this string. The substring starts at a specified character position and has (optionally) a specified length. Return Type: String A new string equivalent to the substring of length length that begins at startIndex in this string. -or- String.Empty if startIndex is equal to the length of this string and length is zero. startIndex - Type: Integer - The index of the start of the substring. length (Optional) - Type: Integer - The number of characters in the substring. |
| toInteger | instance.toInteger Converts the string to an integer. Return Type: Integer An integer value or null if the string was not successfully converted to an integer. |
| toLargeInteger | instance.toLargeInteger Converts the string to a large integer. Return Type: LargeInteger A large integer value or null if the string was not successfully converted to a large integer. |
| toLower | instance.toLower Returns a copy of this string in lowercase. Return Type: String A string in lowercase. |
| toReal | instance.toReal Converts the string to a real-point value. The string MUST use "." as decimal separator. Thousands separator is not allowed. Return Type: Real A ral-point value or null if the string was not successfully converted to a real-point number. |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| toTitleCase | instance.toTitleCase Sets the first character in each word to uppercase and the rest to lowercase. Return Type: String |
| toUpper | instance.toUpper Returns a copy of this string in UPPERCASE. Return Type: String A string in UPPERCASE. |
| trim | instance.trim([trimChars]) Removes all occurrences of a set of characters specified in a string (or all white space characters) from the beginning and end of this string. Return Type: String A new string equalent to this string after all occurrences of the characters in trimChars are removed from the beginning and end of this instance. If trimChars is String.Empty, white space characters are removed instead. trimChars (Optional) - Type: String - An optional string consisting of characters to be removed. If trimChars is left out all whitespace characters will be removed. |
| trimEnd | instance.trimEnd([trimChars]) Removes all occurrences of a set of characters specified in a string (or all whitespace characters) from the end of this string. Return Type: String A new string equalent to this string after all occurrences of the characters in trimChars are removed from the end of this string. If trimChars is null, white space characters are removed instead. trimChars (Optional) - Type: String - An optional string consisting of characters to be removed. If trimChars is left out all whitespace characters will be removed. |
| trimStart | instance.trimStart([trimChars]) Removes all occurrences of a set of characters specified in a string (or all whitespace characters) from the beginning of this string. Return Type: String A new string equalent to this string after all occurrences of the characters in trimChars are removed from the beginning of this string. If trimChars is String.Empty, white space characters are removed instead. trimChars (Optional) - Type: String - An optional string consisting of characters to be removed. If trimChars is left out all whitespace characters will be removed. |
StringIdentifierDomain type
Used to assign a unique identifier to an object. Contains a finite set of identifiers. The StringIdentifierDomain type exposes the following members.
Type members
| Name | Description |
|---|---|
| newIdentifier | StringIdentifierDomain.newIdentifier Reserves and returns the next available identifier. Return Type: String |
Task type
The Task type exposes the following members.
Instance members
| Name | Description |
|---|---|
| constraintDate | instance.constraintDate Return Type: CalendarTime |
| constraintType | instance.constraintType Return Type: TaskConstraintType |
| contact | instance.contact Return Type: String |
| customFields | instance.customFields Return Type: CustomFields |
| deadline | instance.deadline Return Type: CalendarTime |
| duration | instance.duration Return Type: Integer |
| externalUniqueIdentifier | instance.externalUniqueIdentifier Return Type: String |
| finish | instance.finish Return Type: CalendarTime |
| hasDependencies | instance.hasDependencies Return Type: Boolean |
| hyperlink | instance.hyperlink Return Type: String |
| hyperlinkAddress | instance.hyperlinkAddress Return Type: Url |
| hyperlinkHREF | instance.hyperlinkHREF Return Type: Url |
| hyperlinkScreenTip | instance.hyperlinkScreenTip Return Type: String |
| hyperlinkSubAddress | instance.hyperlinkSubAddress Return Type: Url |
| milestone | instance.milestone Return Type: Boolean |
| name | instance.name Return Type: String |
| notes | instance.notes Return Type: String |
| outlineLevel | instance.outlineLevel Return Type: Integer |
| percentComplete | instance.percentComplete Return Type: Integer |
| priority | instance.priority Return Type: Integer |
| sequenceNumber | instance.sequenceNumber Return Type: Integer |
| start | instance.start Return Type: CalendarTime |
| summary | instance.summary Return Type: Boolean |
| summaryUniqueIdentifier | instance.summaryUniqueIdentifier Return Type: Integer |
| taskDependencies | instance.taskDependencies Return Type: Bag(TaskDependencies) |
| uniqueIdentifier | instance.uniqueIdentifier Return Type: Integer |
TaskConstraintType enumeration
The TaskConstraintType enumeration exposes the following members.
| Name | Description |
|---|---|
| asLateAsPossible | TaskConstraintType.asLateAsPossible |
| asSoonAsPossible | TaskConstraintType.asSoonAsPossible |
| finishNoEarlierThan | TaskConstraintType.finishNoEarlierThan |
| finishNoLaterThan | TaskConstraintType.finishNoLaterThan |
| mustFinishOn | TaskConstraintType.mustFinishOn |
| mustStartOn | TaskConstraintType.mustStartOn |
| startNoEarlierThan | TaskConstraintType.startNoEarlierThan |
| startNoLaterThan | TaskConstraintType.startNoLaterThan |
TaskDependency type
The TaskDependency type exposes the following members.
Instance members
| Name | Description |
|---|---|
| dependencyType | instance.dependencyType Return Type: GanttTaskDependency |
| predecessorUniqueIdentifier | instance.predecessorUniqueIdentifier Return Type: Integer |
| successorUniqueIdentifier | instance.successorUniqueIdentifier Return Type: Integer |
TaskExtendedAttributes type
The TaskExtendedAttributes type exposes the following members.
Instance members
| Name | Description |
|---|---|
| date1 | instance.date1 Return Type: CalendarTime |
| date2 | instance.date2 Return Type: CalendarTime |
| date3 | instance.date3 Return Type: CalendarTime |
| date4 | instance.date4 Return Type: CalendarTime |
| date5 | instance.date5 Return Type: CalendarTime |
| number1 | instance.number1 Return Type: Real |
| number2 | instance.number2 Return Type: Real |
| number3 | instance.number3 Return Type: Real |
| number4 | instance.number4 Return Type: Real |
| number5 | instance.number5 Return Type: Real |
| text1 | instance.text1 Return Type: String |
| text2 | instance.text2 Return Type: String |
| text3 | instance.text3 Return Type: String |
| text4 | instance.text4 Return Type: String |
| text5 | instance.text5 Return Type: String |
TextMatching enumeration
Specifies the method of text matching. The TextMatching enumeration exposes the following members.
| Name | Description |
|---|---|
| exact | TextMatching.exact Specifies that the string must contain words matching exactly the specified text. |
| startsWith | TextMatching.startsWith Specifies that the string must contain words starting with the specified text. |
ThirdOfYear_WeekBased type
The ThirdOfYear_WeekBased type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | ThirdOfYear_WeekBased.fromCalendarTime(value) Return Type: ThirdOfYear_WeekBased value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| endDate | instance.endDate Return Type: CalendarTime |
| id | instance.id Return Type: CalendarTime |
| periodType | instance.periodType Return Type: Integer |
| sequenceNumber | instance.sequenceNumber Return Type: Integer |
| thirdOfYear_WeekBased_AndYearName | instance.thirdOfYear_WeekBased_AndYearName Return Type: String |
| yearNumber | instance.yearNumber Return Type: Integer |
Time type
Represents an instant in time, expressed as time of day. The Time type exposes the following members.
Type members
| Name | Description |
|---|---|
| new | Time.new(hour, minute, second) Return Type: Time hour - Type: Integer minute - Type: Integer second - Type: Integer |
| new | Time.new(hour, minute, second, millisecond) Return Type: Time hour - Type: Integer minute - Type: Integer second - Type: Integer millisecond - Type: Integer |
| now | Time.now Return Type: Time |
| utcNow | Time.utcNow Return Type: Time |
Instance members
| Name | Description |
|---|---|
| addHours | instance.addHours(value) Return Type: Time value - Type: Integer |
| addMilliseconds | instance.addMilliseconds(value) Return Type: Time value - Type: Integer |
| addMinutes | instance.addMinutes(value) Return Type: Time value - Type: Integer |
| addSeconds | instance.addSeconds(value) Return Type: Time value - Type: Integer |
| hour | instance.hour Return Type: Integer |
| millisecond | instance.millisecond Return Type: Integer |
| minute | instance.minute Return Type: Integer |
| second | instance.second Return Type: Integer |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
| toString | instance.toString(format) Return Type: String format - Type: String |
TimeResolution enumeration
Specifies the time resolution of a CalendarTime. The TimeResolution enumeration exposes the following members.
| Name | Description |
|---|---|
| day | TimeResolution.day Specifies a resolution of day. |
| hour | TimeResolution.hour Specifies a resolution of hour. |
| millisecond | TimeResolution.millisecond Specifies a resolution of millisecond. |
| minute | TimeResolution.minute Specifies a resolution of minute. |
| month | TimeResolution.month Specifies a resolution of month. |
| second | TimeResolution.second Specifies a resolution of second. |
| year | TimeResolution.year Specifies a resolution of year. |
TimeSpanResolution enumeration
Specifies the time resolution of a CalendarTimeSpan. The TimeSpanResolution enumeration exposes the following members.
| Name | Description |
|---|---|
| days | TimeSpanResolution.days Specifies a resolution of days. |
| hours | TimeSpanResolution.hours Specifies a resolution of hours. |
| milliseconds | TimeSpanResolution.milliseconds Specifies a resolution of milliseconds. |
| minutes | TimeSpanResolution.minutes Specifies a resolution of minutes. |
| months | TimeSpanResolution.months Specifies a resolution of months. |
| seconds | TimeSpanResolution.seconds Specifies a resolution of seconds. |
| years | TimeSpanResolution.years Specifies a resolution of years. |
UIControlOrientation type
The UIControlOrientation type exposes the following members.
Type members
| Name | Description |
|---|---|
| horizontal | UIControlOrientation.horizontal Return Type: UIControlOrientation |
| ocGroup | UIControlOrientation.ocGroup Return Type: String |
| ocName | UIControlOrientation.ocName Return Type: String |
| vertical | UIControlOrientation.vertical Return Type: UIControlOrientation |
Instance members
| Name | Description |
|---|---|
| allObjects | instance.allObjects Return Type: Set(UIControlOrientation) |
| hasDeletePermissions | instance.hasDeletePermissions Return Type: Boolean |
| hasModifyPermissions | instance.hasModifyPermissions Return Type: Boolean |
| id | instance.id Return Type: Integer |
| isModified | instance.isModified Return Type: Boolean |
| isPersisted | instance.isPersisted Return Type: Boolean |
| isValid | instance.isValid Return Type: Boolean |
| name | instance.name Return Type: String |
| orderIndex | instance.orderIndex Return Type: Integer |
Url type
Represents the address (Uniform Resource Locator) to a resource on the Internet. The Url type exposes the following members.
Type members
| Name | Description |
|---|---|
| createSlugString | Url.createSlugString(value, toLower [, maxLength]) Creates a string that may be used directly as part of a URL based on a general string. Return Type: String A SEO (Search Engine Optimization) friendly string based on the specified value, but where all characters (including special characters and whitespace) that are not within the ranges "a".."z", "A".."Z", "0".."9", or "-" are converted to a character that is. value - Type: String - A string value. toLower - Type: Boolean - A value indicating whether the result should be returned as lowercase letters only. maxLength (Optional) - Type: Integer - Default Value: 0 - The result maximum length. (The default value of 0 means "unlimited"). |
| new | Url.new(url) Creates a new instance of the Url class with the specified URL. Return Type: Url url - Type: String - A string representing a URL. |
| new | Url.new(scheme, host [, port] [, path] [, query] [, fragment]) Creates a new instance of the Url class with the specified scheme, host, port number, path, query string, and fragment identifier. Return Type: Url scheme - Type: String - An Internet access protocol. host - Type: String - A DNS-style domain name or IP address. port (Optional) - Type: Integer - An IP port number for the service. path (Optional) - Type: String - The path to the Internet resource. query (Optional) - Type: String - A query string. If a value is specified, it must always start with a question mark (?) sign. fragment (Optional) - Type: String - A fragment identifier. If a value is specified, it must always start with a number (#) sign. |
| urlDecode | Url.urlDecode(value) Converts a string that has been encoded for transmission in a URL into a decoded string. Return Type: String Returns a decoded string. URL decoding replaces hexadecimal escape sequences with corresponding ASCII character equivalents. value - Type: String - A URL-encoded string to decode. |
| urlEncode | Url.urlEncode(value) Converts a text string into a URL encoded string. Return Type: String URL encoding replaces all character codes except for letters, numbers, and the following punctuation characters: - (minus sign), _ (underscore), . (period), ! (exclamation point), * (asterisk), ( and ) (opening and closing parentheses). value - Type: String - The text to URL-encode. |
Instance members
| Name | Description |
|---|---|
| fragment | instance.fragment Gets the fragment portion of the URL. The property gets any text following a fragment marker (#) in the URL, including the fragment marker itself. Given the URL http://www.contoso.com/index.htm#main, the property would return #main. Return Type: String |
| host | instance.host Gets the Domain Name System (DNS) host name or IP address of a server. Return Type: String |
| path | instance.path Gets the path to the resource referenced by the URL. The property contains the path information that the server uses to resolve requests for information. Typically this is the path to the desired information on the server's file system, although it also can indicate the app or script the server must run to provide the information. The path information does not include the scheme, host name, or query portion of the URL. Return Type: String |
| port | instance.port Gets the port number of the URL. The port number defines the protocol port used for contacting the server referenced in the URL. If a port is not specified as part of the URL, the property returns the default value for the protocol. If there is no default port number, this property returns null. Return Type: Integer |
| query | instance.query Gets any query information included in the URL. The property contains any query information included in the URI. Query information is separated from the path information by a question mark (?) and continues to the end of the URL or to a number sign (#). The query information returned includes the leading question mark. Return Type: String |
| scheme | instance.scheme Gets the scheme name of the URL. Possible values returned by the property include file, ftp, http, and https. Return Type: String |
| toString | instance.toString Returns a string representation of the value. Return Type: String |
UserSession type
The UserSession type exposes the following members.
Type members
| Name | Description |
|---|---|
| fullName | UserSession.fullName Return Type: String |
| ipAddress | UserSession.ipAddress Return Type: String |
| mailAddress | UserSession.mailAddress Return Type: String |
| userName | UserSession.userName Return Type: String |
Week type
The Week type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | Week.fromCalendarTime(value) Return Type: Week value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| endDate | instance.endDate Return Type: CalendarTime |
| id | instance.id Return Type: CalendarTime |
| periodType | instance.periodType Return Type: Integer |
| startDate | instance.startDate Return Type: CalendarTime |
| weekAndYearName | instance.weekAndYearName Return Type: String |
| weekNumber | instance.weekNumber Return Type: Integer |
| yearNumber | instance.yearNumber Return Type: Integer |
XmlNode type
Represents a single node in an XML document. The XmlNode type exposes the following members.
Type members
| Name | Description |
|---|---|
| createAttributeNode | XmlNode.createAttributeNode(qualifiedName, namespaceURI, value) Creates an XML attribute node with the specified name, namespaceURI, and value. Return Type: XmlNode qualifiedName - Type: String - The qualified name of the attribute. If the name contains a colon then the Prefix property will reflect the part of the name preceding the colon and the LocalName property will reflect the part after the colon. namespaceURI - Type: String - The namespaceURI of the attribute. If the qualified name includes a prefix of xmlns, then this parameter must be http://www.w3.org/2000/xmlns/. value - Type: String - The value of the node. |
| createElementNode | XmlNode.createElementNode(outerXml) Creates an XML element. Return Type: XmlNode outerXml - Type: String - The XML markup representing this node and all its child nodes. |
| createTextNode | XmlNode.createTextNode(text) Creates an XML text node with the specified text. Return Type: XmlNode text - Type: String - The text for the text node. |
Instance members
| Name | Description |
|---|---|
| innerText | instance.innerText Gets the concatenated values of the node and all its child nodes. Return Type: String |
| innerXml | instance.innerXml Gets the XML markup representing only the child nodes of this node. Return Type: String |
| localName | instance.localName Gets the local name of the node. Return Type: String |
| name | instance.name Gets the qualified name of the node. Return Type: String |
| namespaceUri | instance.namespaceUri Gets the namespaceURI of this node. Return Type: String |
| outerXml | instance.outerXml Gets the XML markup representing this node and all its child nodes. Return Type: String |
| prefix | instance.prefix Gets the namespace prefix of this node. Return Type: String |
| value | instance.value Gets the value of the node. Return Type: String |
Year type
The Year type exposes the following members.
Type members
| Name | Description |
|---|---|
| fromCalendarTime | Year.fromCalendarTime(value) Return Type: Year value - Type: CalendarTime |
Instance members
| Name | Description |
|---|---|
| endDate | instance.endDate Return Type: CalendarTime |
| id | instance.id Return Type: CalendarTime |
| name | instance.name Return Type: String |
| periodType | instance.periodType Return Type: Integer |
| startDate | instance.startDate Return Type: CalendarTime |
| year | instance.year Return Type: Integer |
| year_mnc1 | instance.year_mnc1 Return Type: Integer |
This article was auto-generated by Genus Apps. Any modifications will be overwritten.