From 1209610bb338b0e50d15920c82d8f4e312faee26 Mon Sep 17 00:00:00 2001 From: Aya Morisawa Date: Wed, 27 Jan 2016 19:35:39 +0900 Subject: [PATCH] Remove trailing whitespaces --- xrm/xrm-6.d.ts | 120 ++++++++++++++++++++++---------------------- xrm/xrm-7.0.d.ts | 126 +++++++++++++++++++++++----------------------- xrm/xrm.d.ts | 128 +++++++++++++++++++++++------------------------ 3 files changed, 187 insertions(+), 187 deletions(-) diff --git a/xrm/xrm-6.d.ts b/xrm/xrm-6.d.ts index 0177638034..09c5baa1f9 100644 --- a/xrm/xrm-6.d.ts +++ b/xrm/xrm-6.d.ts @@ -49,7 +49,7 @@ declare module Xrm * Gets current styling theme. * * @return The name of the current theme, as either "default", "Office12Blue", or "Office14Silver" - * + * * @remarks This function does not work with Dynamics CRM for tablets. */ getCurrentTheme(): string; @@ -58,7 +58,7 @@ declare module Xrm * Gets organization's LCID (language code). * * @return The organization language code. - * + * * @see {@link http://msdn.microsoft.com/en-us/library/ms912047(WinEmbedded.10).aspx|Microsoft Locale ID Values} */ getOrgLcid(): number; @@ -67,7 +67,7 @@ declare module Xrm * Gets organization's unique name. * * @return The organization's unique name. - * + * * @remarks This value can be found on the Developer Resources page within Dynamics CRM */ getOrgUniqueName(): string; @@ -83,7 +83,7 @@ declare module Xrm * Gets user's unique identifier. * * @return The user's identifier in Guid format. - * + * * @remarks Example: "{B05EC7CE-5D51-DF11-97E0-00155DB232D0}" */ getUserId(): string; @@ -92,7 +92,7 @@ declare module Xrm * Gets user's LCID (language code). * * @return The user's language code. - * + * * @see {@link http://msdn.microsoft.com/en-us/library/ms912047(WinEmbedded.10).aspx|Microsoft Locale ID Values} */ getUserLcid(): number; @@ -108,7 +108,7 @@ declare module Xrm * Gets all user security roles. * * @return An array of user role identifiers, in Guid format. - * + * * @remarks Example: ["cf4cc7ce-5d51-df11-97e0-00155db232d0"] */ getUserRoles(): string[]; @@ -119,7 +119,7 @@ declare module Xrm * @param {string} sPath Local pathname of the resource. * * @return A path string with the organization name. - * + * * @remarks Format: "/"+ OrgName + sPath */ prependOrgName( sPath: string ): string; @@ -247,7 +247,7 @@ declare module Xrm * @param {string} itemName The item name to get. * * @return The T matching the key itemName. - * + * * @see {@link Xrm.Page.Control.getName()} for Control-naming schemes. */ get( itemName: string ): T; @@ -270,7 +270,7 @@ declare module Xrm /** * The Xrm.Page API - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328255.aspx|Documentation} for details. */ export module Page @@ -329,7 +329,7 @@ declare module Xrm * Gets save-event arguments. * * @return The event arguments. - * + * * @remarks Returns null for all but the "save" event. */ getEventArgs(): SaveEventArguments; @@ -348,7 +348,7 @@ declare module Xrm * @param {string} key The key. * * @return The shared variable. - * + * * @remarks Used to pass values between handlers of an event. */ getSharedVariable( key: string ): T; @@ -359,7 +359,7 @@ declare module Xrm * @tparam T Generic type parameter. * @param {string} key The key. * @param {T} value The value. - * + * * @remarks Used to pass values between handlers of an event. */ setSharedVariable( key: string, value: T ): void; @@ -508,7 +508,7 @@ declare module Xrm * Gets attribute type. * * @return The attribute's type name. - * + * * @remarks Values returned are: boolean * datetime * decimal @@ -526,9 +526,9 @@ declare module Xrm * Gets the attribute format. * * @return The format of the attribute. - * + * * @see {@link getAttributeType()} - * + * * @remarks Values returned are: date (datetime) * datetime (datetime) * duration (integer) @@ -576,7 +576,7 @@ declare module Xrm * Gets current submit mode for the attribute. * * @return The submit mode, as either "always", "never", or "dirty" - * + * * @remarks The default value is "dirty" */ getSubmitMode(): string; @@ -648,7 +648,7 @@ declare module Xrm * Sets the submit mode. * * @param {string} submitMode The submit mode, as either "always", "never", or "dirty". - * + * * @remarks The default value is "dirty" */ setSubmitMode( submitMode: string ): void; @@ -693,7 +693,7 @@ declare module Xrm * Sets the value. * * @param {number} value The value. - * + * * @remarks Attributes on Quick Create Forms will not save values set with this method. */ setValue( value: number ): void; @@ -710,7 +710,7 @@ declare module Xrm * Gets maximum length allowed. * * @return The maximum length allowed. - * + * * @remarks The email form's "Description" attribute does not have the this method. */ getMaxLength(): number; @@ -889,7 +889,7 @@ declare module Xrm * Sets the value. * * @param {LookupValue[]} value The value. - * + * * @remarks Attributes on Quick Create Forms will not save values set with this method. */ setValue( value: LookupValue[] ): void; @@ -951,7 +951,7 @@ declare module Xrm * Gets the record's primary attribute value. * * @return The primary attribute value. - * + * * @remarks The value for this attribute is used when links to the record are displayed. */ getPrimaryAttributeValue(): string; @@ -1007,7 +1007,7 @@ declare module Xrm * @remarks Values returned are: 1 Save * 2 Save and Close * 59 Save and New - * 70 AutoSave (Where enabled; can be used with an OnSave handler + * 70 AutoSave (Where enabled; can be used with an OnSave handler * to conditionally disable auto-saving) * 58 Save as Completed (Activities) * 5 Deactivate @@ -1073,7 +1073,7 @@ declare module Xrm * @param {string} uniqueId (Optional) Unique identifier. * * @return true if it succeeds, false if it fails. - * + * * @remarks If the uniqueId parameter is not used, the current notification shown will be removed. */ clearNotification( uniqueId?: string ): boolean; @@ -1124,7 +1124,7 @@ declare module Xrm * @return The parent Section. */ getParent(): Section; - + /** * Sets the state of the control to either enabled, or disabled. * @@ -1209,7 +1209,7 @@ declare module Xrm /** * Adds an additional custom filter to the lookup, with the "AND" filter operator. * Can only be used within a "pre search" event handler - * + * * @sa addPreSearch * * @param {string} filter Specifies the filter, as a serialized FetchXML @@ -1233,7 +1233,7 @@ declare module Xrm * @param {string} fetchXml The FetchXML query for the view's contents, serialized as a string. * @param {string} layoutXml The Layout XML, serialized as a string. * @param {boolean} isDefault true, to treat this view as default. - * + * * @remarks Cannot be used on "Owner" Lookup controls. * The viewId is never saved to CRM, but must be unique across available views. Generating * a new value can be accomplished with a {@link http://www.guidgen.com/|Guid generator}. @@ -1253,7 +1253,7 @@ declare module Xrm * Gets the unique identifier of the default view. * * @return The default view, in Guid format. - * + * * @remarks Example: "{00000000-0000-0000-0000-000000000000}" */ getDefaultView(): string; @@ -1269,7 +1269,7 @@ declare module Xrm * Sets the Lookup's default view. * * @param {string} viewGuid Unique identifier for the view. - * + * * @remarks Example viewGuid value: "{00000000-0000-0000-0000-000000000000}" */ setDefaultView( viewGuid: string ): void; @@ -1287,7 +1287,7 @@ declare module Xrm * * @param {OptionSetValue} option The option. * @param {number} index (Optional) zero-based index of the option. - * + * * @remarks This method does not check that the values within the options you add are valid. * If index is not provided, the new option will be added to the end of the list. */ @@ -1322,7 +1322,7 @@ declare module Xrm { /** * Refreshes the sub grid. - * + * * @remarks Not available during the "on load" event of the form. */ refresh(): void; @@ -1342,7 +1342,7 @@ declare module Xrm * Gets the DOM element containing the control. * * @return The container object. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getObject(): HTMLIFrameElement; @@ -1351,7 +1351,7 @@ declare module Xrm * Gets the URL value of the control. * * @return The source URL. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getSrc(): string; @@ -1360,7 +1360,7 @@ declare module Xrm * Sets the URL value of the control. * * @param {string} src The source URL. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ setSrc( src: string ): void; @@ -1377,7 +1377,7 @@ declare module Xrm * Gets initial URL defined for the Iframe. * * @return The initial URL. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getInitialUrl(): string; @@ -1394,7 +1394,7 @@ declare module Xrm * Gets the query string value passed to Silverlight. * * @return The data. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getData(): string; @@ -1403,7 +1403,7 @@ declare module Xrm * Sets the query string value passed to Silverlight. * * @param {string} data The data. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ setData( data: string ): void; @@ -1412,7 +1412,7 @@ declare module Xrm * Gets the DOM element containing the control. * * @return The container object. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getObject(): HTMLObjectElement; @@ -1513,14 +1513,14 @@ declare module Xrm /** * The form selector API. - * + * * @remarks This API does not exist with Microsoft Dynamics CRM for tablets. */ formSelector: FormSelector; /** * The navigation API. - * + * * @remarks This API does not exist with Microsoft Dynamics CRM for tablets. */ navigation: Navigation; @@ -1550,10 +1550,10 @@ declare module Xrm * @return The form type. * * @remarks Values returned are: 0 Undefined - * 1 Create - * 2 Update - * 3 Read Only - * 4 Disabled + * 1 Create + * 2 Update + * 3 Read Only + * 4 Disabled * 6 Bulk Edit * Deprecated values are 5 (Quick Create), and 11 (Read Optimized) */ @@ -1563,7 +1563,7 @@ declare module Xrm * Gets view port height. * * @return The view port height, in pixels. - * + * * @remarks This method does not work with Microsoft Dynamics CRM for tablets. */ getViewPortHeight(): number; @@ -1572,14 +1572,14 @@ declare module Xrm * Gets view port width. * * @return The view port width, in pixels. - * + * * @remarks This method does not work with Microsoft Dynamics CRM for tablets. */ getViewPortWidth(): number; /** * Re-evaluates the ribbon's configured EnableRules - * + * * @remarks This method does not work with Microsoft Dynamics CRM for tablets. */ refreshRibbon(): void; @@ -1690,7 +1690,7 @@ declare module Xrm * Gets current form. * * @return The current item. - * + * * @remarks When only one form is available this method will return null. */ getCurrentItem(): FormItem; @@ -1807,7 +1807,7 @@ declare module Xrm /** * An definition module for URL-based, CRM component parameters. - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ export module Url @@ -1823,11 +1823,11 @@ declare module Xrm /** * Interface for defining parameters on a request to open a form with main.aspx (as with - * window.open). Useful for parsing the keys and values into a string of the format: + * window.open). Useful for parsing the keys and values into a string of the format: * "&key=value". * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. - * + * * @remarks A member for "pagetype" is not provided. The value "entityrecord" is required in * the URL, for forms. Example: "pagetype=entityrecord" */ @@ -1842,7 +1842,7 @@ declare module Xrm * Additional parameters can be provided to the request. This can only be used to provide * default field values for the form, or pass data to custom parameters that have been * customized for the form. See example below for setting the selected form. - * + * * @remarks Example: encodeURIComponent( "formid={8c9f3e6f-7839-e211-831e-00155db7d98f}" ); */ extraqs?: string; @@ -1866,9 +1866,9 @@ declare module Xrm /** * Interface for defining parameters on a request to open a view with main.aspx (as with - * window.open). Useful for parsing the keys and values into a string of the format: + * window.open). Useful for parsing the keys and values into a string of the format: * "&key=value". - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. * * @remarks A member for "pagetype" is not provided. The value "entitylist" is required in @@ -1914,9 +1914,9 @@ declare module Xrm /** * Interface for defining parameters of a request to open a dialog with rundialog.aspx (as with - * window.open). Useful for parsing the keys and values into a string of the format: + * window.open). Useful for parsing the keys and values into a string of the format: * "&key=value". - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ export interface DialogOpenParameters @@ -1942,7 +1942,7 @@ declare module Xrm * Interface for defining parameters of a request to open a report with viewer.apsx (as with * window.open). Useful for parsing out the keys and values into a string of the format: * "&key=value" - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ export interface ReportOpenParameters @@ -1950,7 +1950,7 @@ declare module Xrm /** * The action to perform, as either "run" or "filter". * - * @remarks "run" Executes the report with default filters. + * @remarks "run" Executes the report with default filters. * "filter" Presents the user with the filter editor, and a "Run Report" button. */ action: string; @@ -1970,7 +1970,7 @@ declare module Xrm /** * The Xrm.Utility API - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328255.aspx|Documentation} for details. */ export module Utility @@ -2056,7 +2056,7 @@ declare module Xrm * @param {number} height (Optional) The height of the new window. * * @return A Window reference, containing the opened Web Resource. - * + * * @remarks This function will not work with Microsoft Dynamics CRM for tablets. * Valid WebResource URL Parameters: typename * type @@ -2073,7 +2073,7 @@ declare module Xrm /** * Gets the xRM application context, for HTML web resources, included by ClientGlobalContext.js.aspx * @returns {Xrm.Context} The application context for the user's current session. - * @remarks The ClientGlobalContext.js.aspx page will include some global event handlers. These event handlers will + * @remarks The ClientGlobalContext.js.aspx page will include some global event handlers. These event handlers will * cancel the onselectstart, contextmenu, and ondragstart events. */ declare function GetGlobalContext(): Xrm.Context; diff --git a/xrm/xrm-7.0.d.ts b/xrm/xrm-7.0.d.ts index c098759cbd..733a25fc7d 100644 --- a/xrm/xrm-7.0.d.ts +++ b/xrm/xrm-7.0.d.ts @@ -49,7 +49,7 @@ declare module Xrm * Gets current styling theme. * * @return The name of the current theme, as either "default", "Office12Blue", or "Office14Silver" - * + * * @remarks This function does not work with Dynamics CRM for tablets. */ getCurrentTheme(): string; @@ -65,7 +65,7 @@ declare module Xrm * Gets organization's LCID (language code). * * @return The organization language code. - * + * * @see {@link http://msdn.microsoft.com/en-us/library/ms912047(WinEmbedded.10).aspx|Microsoft Locale ID Values} */ getOrgLcid(): number; @@ -74,7 +74,7 @@ declare module Xrm * Gets organization's unique name. * * @return The organization's unique name. - * + * * @remarks This value can be found on the Developer Resources page within Dynamics CRM */ getOrgUniqueName(): string; @@ -90,7 +90,7 @@ declare module Xrm * Gets user's unique identifier. * * @return The user's identifier in Guid format. - * + * * @remarks Example: "{B05EC7CE-5D51-DF11-97E0-00155DB232D0}" */ getUserId(): string; @@ -99,7 +99,7 @@ declare module Xrm * Gets user's LCID (language code). * * @return The user's language code. - * + * * @see {@link http://msdn.microsoft.com/en-us/library/ms912047(WinEmbedded.10).aspx|Microsoft Locale ID Values} */ getUserLcid(): number; @@ -115,7 +115,7 @@ declare module Xrm * Gets all user security roles. * * @return An array of user role identifiers, in Guid format. - * + * * @remarks Example: ["cf4cc7ce-5d51-df11-97e0-00155db232d0"] */ getUserRoles(): string[]; @@ -126,7 +126,7 @@ declare module Xrm * @param {string} sPath Local pathname of the resource. * * @return A path string with the organization name. - * + * * @remarks Format: "/"+ OrgName + sPath */ prependOrgName( sPath: string ): string; @@ -242,7 +242,7 @@ declare module Xrm * @param {string} itemName The item name to get. * * @return The T matching the key itemName. - * + * * @see {@link Xrm.Page.Control.getName()} for Control-naming schemes. */ get( itemName: string ): T; @@ -265,7 +265,7 @@ declare module Xrm /** * The Xrm.Page API - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328255.aspx|Documentation} for details. */ export module Page @@ -321,7 +321,7 @@ declare module Xrm * Returns the unique identifier of the process. * * @return The identifier for this process, in GUID format. - * + * * @remarks Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}". */ getId(): string; @@ -372,7 +372,7 @@ declare module Xrm * Returns the unique identifier of the stage. * * @return The identifier of the Stage, in GUID format. - * + * * @remarks Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}". */ getId(): string; @@ -454,7 +454,7 @@ declare module Xrm * Gets save-event arguments. * * @return The event arguments. - * + * * @remarks Returns null for all but the "save" event. */ getEventArgs(): SaveEventArguments; @@ -473,7 +473,7 @@ declare module Xrm * @param {string} key The key. * * @return The shared variable. - * + * * @remarks Used to pass values between handlers of an event. */ getSharedVariable( key: string ): T; @@ -484,7 +484,7 @@ declare module Xrm * @tparam T Generic type parameter. * @param {string} key The key. * @param {T} value The value. - * + * * @remarks Used to pass values between handlers of an event. */ setSharedVariable( key: string, value: T ): void; @@ -628,7 +628,7 @@ declare module Xrm * Gets attribute type. * * @return The attribute's type name. - * + * * @remarks Values returned are: boolean * datetime * decimal @@ -646,9 +646,9 @@ declare module Xrm * Gets the attribute format. * * @return The format of the attribute. - * + * * @see {@link getAttributeType()} - * + * * @remarks Values returned are: date (datetime) * datetime (datetime) * duration (integer) @@ -696,7 +696,7 @@ declare module Xrm * Gets current submit mode for the attribute. * * @return The submit mode, as either "always", "never", or "dirty" - * + * * @remarks The default value is "dirty" */ getSubmitMode(): string; @@ -768,7 +768,7 @@ declare module Xrm * Sets the submit mode. * * @param {string} submitMode The submit mode, as either "always", "never", or "dirty". - * + * * @remarks The default value is "dirty" */ setSubmitMode( submitMode: string ): void; @@ -818,7 +818,7 @@ declare module Xrm * Sets the value. * * @param {number} value The value. - * + * * @remarks Attributes on Quick Create Forms will not save values set with this method. */ setValue( value: number ): void; @@ -835,7 +835,7 @@ declare module Xrm * Gets maximum length allowed. * * @return The maximum length allowed. - * + * * @remarks The email form's "Description" attribute does not have the this method. */ getMaxLength(): number; @@ -1014,7 +1014,7 @@ declare module Xrm * Sets the value. * * @param {LookupValue[]} value The value. - * + * * @remarks Attributes on Quick Create Forms will not save values set with this method. */ setValue( value: LookupValue[] ): void; @@ -1071,7 +1071,7 @@ declare module Xrm * Gets the record's primary attribute value. * * @return The primary attribute value. - * + * * @remarks The value for this attribute is used when links to the record are displayed. */ getPrimaryAttributeValue(): string; @@ -1132,7 +1132,7 @@ declare module Xrm * @remarks Values returned are: 1 Save * 2 Save and Close * 59 Save and New - * 70 AutoSave (Where enabled; can be used with an OnSave handler + * 70 AutoSave (Where enabled; can be used with an OnSave handler * to conditionally disable auto-saving) * 58 Save as Completed (Activities) * 5 Deactivate @@ -1220,7 +1220,7 @@ declare module Xrm * Id of the business process flow and the value of * the property is the name of the business process * flow. - * + * * The enabled processes are filtered according to * the user’s privileges. The list of enabled * processes is the same ones a user can see in the @@ -1323,7 +1323,7 @@ declare module Xrm * @param {string} uniqueId (Optional) Unique identifier. * * @return true if it succeeds, false if it fails. - * + * * @remarks If the uniqueId parameter is not used, the current notification shown will be removed. */ clearNotification( uniqueId?: string ): boolean; @@ -1374,7 +1374,7 @@ declare module Xrm * @return The parent Section. */ getParent(): Section; - + /** * Sets the state of the control to either enabled, or disabled. * @@ -1459,7 +1459,7 @@ declare module Xrm /** * Adds an additional custom filter to the lookup, with the "AND" filter operator. * Can only be used within a "pre search" event handler - * + * * @sa addPreSearch * * @param {string} filter Specifies the filter, as a serialized FetchXML @@ -1483,7 +1483,7 @@ declare module Xrm * @param {string} fetchXml The FetchXML query for the view's contents, serialized as a string. * @param {string} layoutXml The Layout XML, serialized as a string. * @param {boolean} isDefault true, to treat this view as default. - * + * * @remarks Cannot be used on "Owner" Lookup controls. * The viewId is never saved to CRM, but must be unique across available views. Generating * a new value can be accomplished with a {@link http://www.guidgen.com/|Guid generator}. @@ -1503,7 +1503,7 @@ declare module Xrm * Gets the unique identifier of the default view. * * @return The default view, in Guid format. - * + * * @remarks Example: "{00000000-0000-0000-0000-000000000000}" */ getDefaultView(): string; @@ -1519,7 +1519,7 @@ declare module Xrm * Sets the Lookup's default view. * * @param {string} viewGuid Unique identifier for the view. - * + * * @remarks Example viewGuid value: "{00000000-0000-0000-0000-000000000000}" */ setDefaultView( viewGuid: string ): void; @@ -1537,7 +1537,7 @@ declare module Xrm * * @param {OptionSetValue} option The option. * @param {number} index (Optional) zero-based index of the option. - * + * * @remarks This method does not check that the values within the options you add are valid. * If index is not provided, the new option will be added to the end of the list. */ @@ -1572,7 +1572,7 @@ declare module Xrm { /** * Refreshes the sub grid. - * + * * @remarks Not available during the "on load" event of the form. */ refresh(): void; @@ -1592,7 +1592,7 @@ declare module Xrm * Gets the DOM element containing the control. * * @return The container object. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getObject(): HTMLIFrameElement; @@ -1601,7 +1601,7 @@ declare module Xrm * Gets the URL value of the control. * * @return The source URL. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getSrc(): string; @@ -1610,7 +1610,7 @@ declare module Xrm * Sets the URL value of the control. * * @param {string} src The source URL. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ setSrc( src: string ): void; @@ -1627,7 +1627,7 @@ declare module Xrm * Gets initial URL defined for the Iframe. * * @return The initial URL. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getInitialUrl(): string; @@ -1644,7 +1644,7 @@ declare module Xrm * Gets the query string value passed to Silverlight. * * @return The data. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getData(): string; @@ -1653,7 +1653,7 @@ declare module Xrm * Sets the query string value passed to Silverlight. * * @param {string} data The data. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ setData( data: string ): void; @@ -1662,7 +1662,7 @@ declare module Xrm * Gets the DOM element containing the control. * * @return The container object. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getObject(): HTMLObjectElement; @@ -1810,10 +1810,10 @@ declare module Xrm * @return The form type. * * @remarks Values returned are: 0 Undefined - * 1 Create - * 2 Update - * 3 Read Only - * 4 Disabled + * 1 Create + * 2 Update + * 3 Read Only + * 4 Disabled * 6 Bulk Edit * Deprecated values are 5 (Quick Create), and 11 (Read Optimized) */ @@ -1823,7 +1823,7 @@ declare module Xrm * Gets view port height. * * @return The view port height, in pixels. - * + * * @remarks This method does not work with Microsoft Dynamics CRM for tablets. */ export function getViewPortHeight(): number; @@ -1832,14 +1832,14 @@ declare module Xrm * Gets view port width. * * @return The view port width, in pixels. - * + * * @remarks This method does not work with Microsoft Dynamics CRM for tablets. */ export function getViewPortWidth(): number; /** * Re-evaluates the ribbon's configured EnableRules - * + * * @remarks This method does not work with Microsoft Dynamics CRM for tablets. */ export function refreshRibbon(): void; @@ -1897,14 +1897,14 @@ declare module Xrm /** * The form selector API. - * + * * @remarks This API does not exist with Microsoft Dynamics CRM for tablets. */ export var formSelector: FormSelector; /** * The navigation API. - * + * * @remarks This API does not exist with Microsoft Dynamics CRM for tablets. */ export var navigation: Navigation; @@ -1976,7 +1976,7 @@ declare module Xrm * Gets current form. * * @return The current item. - * + * * @remarks When only one form is available this method will return null. */ getCurrentItem(): FormItem; @@ -2083,7 +2083,7 @@ declare module Xrm /** * An definition module for URL-based, CRM component parameters. - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ export module Url @@ -2099,11 +2099,11 @@ declare module Xrm /** * Interface for defining parameters on a request to open a form with main.aspx (as with - * window.open). Useful for parsing the keys and values into a string of the format: + * window.open). Useful for parsing the keys and values into a string of the format: * "&key=value". * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. - * + * * @remarks A member for "pagetype" is not provided. The value "entityrecord" is required in * the URL, for forms. Example: "pagetype=entityrecord" */ @@ -2118,7 +2118,7 @@ declare module Xrm * Additional parameters can be provided to the request. This can only be used to provide * default field values for the form, or pass data to custom parameters that have been * customized for the form. See example below for setting the selected form. - * + * * @remarks Example: encodeURIComponent( "formid={8c9f3e6f-7839-e211-831e-00155db7d98f}" ); */ extraqs?: string; @@ -2142,9 +2142,9 @@ declare module Xrm /** * Interface for defining parameters on a request to open a view with main.aspx (as with - * window.open). Useful for parsing the keys and values into a string of the format: + * window.open). Useful for parsing the keys and values into a string of the format: * "&key=value". - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. * * @remarks A member for "pagetype" is not provided. The value "entitylist" is required in @@ -2190,9 +2190,9 @@ declare module Xrm /** * Interface for defining parameters of a request to open a dialog with rundialog.aspx (as with - * window.open). Useful for parsing the keys and values into a string of the format: + * window.open). Useful for parsing the keys and values into a string of the format: * "&key=value". - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ export interface DialogOpenParameters @@ -2218,7 +2218,7 @@ declare module Xrm * Interface for defining parameters of a request to open a report with viewer.apsx (as with * window.open). Useful for parsing out the keys and values into a string of the format: * "&key=value" - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ export interface ReportOpenParameters @@ -2226,7 +2226,7 @@ declare module Xrm /** * The action to perform, as either "run" or "filter". * - * @remarks "run" Executes the report with default filters. + * @remarks "run" Executes the report with default filters. * "filter" Presents the user with the filter editor, and a "Run Report" button. */ action: string; @@ -2246,7 +2246,7 @@ declare module Xrm /** * The Xrm.Utility API - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328255.aspx|Documentation} for details. */ export module Utility @@ -2335,7 +2335,7 @@ declare module Xrm * @param {number} height (Optional) The height of the new window. * * @return A Window reference, containing the opened Web Resource. - * + * * @remarks This function will not work with Microsoft Dynamics CRM for tablets. * Valid WebResource URL Parameters: typename * type @@ -2352,7 +2352,7 @@ declare module Xrm /** * Gets the xRM application context, for HTML web resources, included by ClientGlobalContext.js.aspx * @returns {Xrm.Context} The application context for the user's current session. - * @remarks The ClientGlobalContext.js.aspx page will include some global event handlers. These event handlers will + * @remarks The ClientGlobalContext.js.aspx page will include some global event handlers. These event handlers will * cancel the onselectstart, contextmenu, and ondragstart events. */ declare function GetGlobalContext(): Xrm.Context; diff --git a/xrm/xrm.d.ts b/xrm/xrm.d.ts index b3848f1080..a2f7c515ba 100644 --- a/xrm/xrm.d.ts +++ b/xrm/xrm.d.ts @@ -49,7 +49,7 @@ declare module Xrm * Gets current styling theme. * * @return The name of the current theme, as either "default", "Office12Blue", or "Office14Silver" - * + * * @remarks This function does not work with Dynamics CRM for tablets. */ getCurrentTheme(): string; @@ -65,7 +65,7 @@ declare module Xrm * Gets organization's LCID (language code). * * @return The organization language code. - * + * * @see {@link http://msdn.microsoft.com/en-us/library/ms912047(WinEmbedded.10).aspx|Microsoft Locale ID Values} */ getOrgLcid(): number; @@ -74,7 +74,7 @@ declare module Xrm * Gets organization's unique name. * * @return The organization's unique name. - * + * * @remarks This value can be found on the Developer Resources page within Dynamics CRM */ getOrgUniqueName(): string; @@ -97,7 +97,7 @@ declare module Xrm * Gets user's unique identifier. * * @return The user's identifier in Guid format. - * + * * @remarks Example: "{B05EC7CE-5D51-DF11-97E0-00155DB232D0}" */ getUserId(): string; @@ -106,7 +106,7 @@ declare module Xrm * Gets user's LCID (language code). * * @return The user's language code. - * + * * @see {@link http://msdn.microsoft.com/en-us/library/ms912047(WinEmbedded.10).aspx|Microsoft Locale ID Values} */ getUserLcid(): number; @@ -122,7 +122,7 @@ declare module Xrm * Gets all user security roles. * * @return An array of user role identifiers, in Guid format. - * + * * @remarks Example: ["cf4cc7ce-5d51-df11-97e0-00155db232d0"] */ getUserRoles(): string[]; @@ -133,7 +133,7 @@ declare module Xrm * @param {string} sPath Local pathname of the resource. * * @return A path string with the organization name. - * + * * @remarks Format: "/"+ OrgName + sPath */ prependOrgName( sPath: string ): string; @@ -249,7 +249,7 @@ declare module Xrm * @param {string} itemName The item name to get. * * @return The T matching the key itemName. - * + * * @see {@link Xrm.Page.Control.getName()} for Control-naming schemes. */ get( itemName: string ): T; @@ -272,7 +272,7 @@ declare module Xrm /** * The Xrm.Page API - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328255.aspx|Documentation} for details. */ export module Page @@ -343,7 +343,7 @@ declare module Xrm * Returns the unique identifier of the process. * * @return The identifier for this process, in GUID format. - * + * * @remarks Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}". */ getId(): string; @@ -394,7 +394,7 @@ declare module Xrm * Returns the unique identifier of the stage. * * @return The identifier of the Stage, in GUID format. - * + * * @remarks Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}". */ getId(): string; @@ -476,7 +476,7 @@ declare module Xrm * Gets save-event arguments. * * @return The event arguments. - * + * * @remarks Returns null for all but the "save" event. */ getEventArgs(): SaveEventArguments; @@ -495,7 +495,7 @@ declare module Xrm * @param {string} key The key. * * @return The shared variable. - * + * * @remarks Used to pass values between handlers of an event. */ getSharedVariable( key: string ): T; @@ -506,7 +506,7 @@ declare module Xrm * @tparam T Generic type parameter. * @param {string} key The key. * @param {T} value The value. - * + * * @remarks Used to pass values between handlers of an event. */ setSharedVariable( key: string, value: T ): void; @@ -650,7 +650,7 @@ declare module Xrm * Gets attribute type. * * @return The attribute's type name. - * + * * @remarks Values returned are: boolean * datetime * decimal @@ -668,9 +668,9 @@ declare module Xrm * Gets the attribute format. * * @return The format of the attribute. - * + * * @see {@link getAttributeType()} - * + * * @remarks Values returned are: date (datetime) * datetime (datetime) * duration (integer) @@ -718,7 +718,7 @@ declare module Xrm * Gets current submit mode for the attribute. * * @return The submit mode, as either "always", "never", or "dirty" - * + * * @remarks The default value is "dirty" */ getSubmitMode(): string; @@ -790,7 +790,7 @@ declare module Xrm * Sets the submit mode. * * @param {string} submitMode The submit mode, as either "always", "never", or "dirty". - * + * * @remarks The default value is "dirty" */ setSubmitMode( submitMode: string ): void; @@ -840,7 +840,7 @@ declare module Xrm * Sets the value. * * @param {number} value The value. - * + * * @remarks Attributes on Quick Create Forms will not save values set with this method. */ setValue( value: number ): void; @@ -857,7 +857,7 @@ declare module Xrm * Gets maximum length allowed. * * @return The maximum length allowed. - * + * * @remarks The email form's "Description" attribute does not have the this method. */ getMaxLength(): number; @@ -1036,7 +1036,7 @@ declare module Xrm * Sets the value. * * @param {LookupValue[]} value The value. - * + * * @remarks Attributes on Quick Create Forms will not save values set with this method. */ setValue( value: LookupValue[] ): void; @@ -1093,7 +1093,7 @@ declare module Xrm * Gets the record's primary attribute value. * * @return The primary attribute value. - * + * * @remarks The value for this attribute is used when links to the record are displayed. */ getPrimaryAttributeValue(): string; @@ -1154,7 +1154,7 @@ declare module Xrm * @remarks Values returned are: 1 Save * 2 Save and Close * 59 Save and New - * 70 AutoSave (Where enabled; can be used with an OnSave handler + * 70 AutoSave (Where enabled; can be used with an OnSave handler * to conditionally disable auto-saving) * 58 Save as Completed (Activities) * 5 Deactivate @@ -1242,7 +1242,7 @@ declare module Xrm * Id of the business process flow and the value of * the property is the name of the business process * flow. - * + * * The enabled processes are filtered according to * the user’s privileges. The list of enabled * processes is the same ones a user can see in the @@ -1345,7 +1345,7 @@ declare module Xrm * @param {string} uniqueId (Optional) Unique identifier. * * @return true if it succeeds, false if it fails. - * + * * @remarks If the uniqueId parameter is not used, the current notification shown will be removed. */ clearNotification( uniqueId?: string ): boolean; @@ -1397,7 +1397,7 @@ declare module Xrm * @return The parent Section. */ getParent(): Section; - + /** * Sets the state of the control to either enabled, or disabled. * @@ -1489,7 +1489,7 @@ declare module Xrm /** * Adds an additional custom filter to the lookup, with the "AND" filter operator. * Can only be used within a "pre search" event handler - * + * * @sa addPreSearch * * @param {string} filter Specifies the filter, as a serialized FetchXML @@ -1513,7 +1513,7 @@ declare module Xrm * @param {string} fetchXml The FetchXML query for the view's contents, serialized as a string. * @param {string} layoutXml The Layout XML, serialized as a string. * @param {boolean} isDefault true, to treat this view as default. - * + * * @remarks Cannot be used on "Owner" Lookup controls. * The viewId is never saved to CRM, but must be unique across available views. Generating * a new value can be accomplished with a {@link http://www.guidgen.com/|Guid generator}. @@ -1533,7 +1533,7 @@ declare module Xrm * Gets the unique identifier of the default view. * * @return The default view, in Guid format. - * + * * @remarks Example: "{00000000-0000-0000-0000-000000000000}" */ getDefaultView(): string; @@ -1549,7 +1549,7 @@ declare module Xrm * Sets the Lookup's default view. * * @param {string} viewGuid Unique identifier for the view. - * + * * @remarks Example viewGuid value: "{00000000-0000-0000-0000-000000000000}" */ setDefaultView( viewGuid: string ): void; @@ -1567,7 +1567,7 @@ declare module Xrm * * @param {OptionSetValue} option The option. * @param {number} index (Optional) zero-based index of the option. - * + * * @remarks This method does not check that the values within the options you add are valid. * If index is not provided, the new option will be added to the end of the list. */ @@ -1637,7 +1637,7 @@ declare module Xrm /** * Refreshes the sub grid. - * + * * @remarks Not available during the "on load" event of the form. */ refresh(): void; @@ -1664,7 +1664,7 @@ declare module Xrm * Gets the DOM element containing the control. * * @return The container object. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getObject(): HTMLIFrameElement; @@ -1673,7 +1673,7 @@ declare module Xrm * Gets the URL value of the control. * * @return The source URL. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getSrc(): string; @@ -1682,7 +1682,7 @@ declare module Xrm * Sets the URL value of the control. * * @param {string} src The source URL. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ setSrc( src: string ): void; @@ -1699,7 +1699,7 @@ declare module Xrm * Gets initial URL defined for the Iframe. * * @return The initial URL. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getInitialUrl(): string; @@ -1716,7 +1716,7 @@ declare module Xrm * Gets the query string value passed to Silverlight. * * @return The data. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getData(): string; @@ -1725,7 +1725,7 @@ declare module Xrm * Sets the query string value passed to Silverlight. * * @param {string} data The data. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ setData( data: string ): void; @@ -1734,7 +1734,7 @@ declare module Xrm * Gets the DOM element containing the control. * * @return The container object. - * + * * @remarks Unavailable for Microsoft Dynamics CRM for tablets. */ getObject(): HTMLObjectElement; @@ -1942,7 +1942,7 @@ declare module Xrm * Returns the id for the record in the row. * * @return The identifier of the GridEntity, in GUID format. - * + * * @remarks Example return: "{00000000-0000-0000-0000-000000000000}" */ getId(): string; @@ -2017,10 +2017,10 @@ declare module Xrm * @return The form type. * * @remarks Values returned are: 0 Undefined - * 1 Create - * 2 Update - * 3 Read Only - * 4 Disabled + * 1 Create + * 2 Update + * 3 Read Only + * 4 Disabled * 6 Bulk Edit * Deprecated values are 5 (Quick Create), and 11 (Read Optimized) */ @@ -2030,7 +2030,7 @@ declare module Xrm * Gets view port height. * * @return The view port height, in pixels. - * + * * @remarks This method does not work with Microsoft Dynamics CRM for tablets. */ export function getViewPortHeight(): number; @@ -2039,14 +2039,14 @@ declare module Xrm * Gets view port width. * * @return The view port width, in pixels. - * + * * @remarks This method does not work with Microsoft Dynamics CRM for tablets. */ export function getViewPortWidth(): number; /** * Re-evaluates the ribbon's configured EnableRules - * + * * @remarks This method does not work with Microsoft Dynamics CRM for tablets. */ export function refreshRibbon(): void; @@ -2104,14 +2104,14 @@ declare module Xrm /** * The form selector API. - * + * * @remarks This API does not exist with Microsoft Dynamics CRM for tablets. */ export var formSelector: FormSelector; /** * The navigation API. - * + * * @remarks This API does not exist with Microsoft Dynamics CRM for tablets. */ export var navigation: Navigation; @@ -2183,7 +2183,7 @@ declare module Xrm * Gets current form. * * @return The current item. - * + * * @remarks When only one form is available this method will return null. */ getCurrentItem(): FormItem; @@ -2290,7 +2290,7 @@ declare module Xrm /** * An definition module for URL-based, CRM component parameters. - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ export module Url @@ -2306,11 +2306,11 @@ declare module Xrm /** * Interface for defining parameters on a request to open a form with main.aspx (as with - * window.open). Useful for parsing the keys and values into a string of the format: + * window.open). Useful for parsing the keys and values into a string of the format: * "&key=value". * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. - * + * * @remarks A member for "pagetype" is not provided. The value "entityrecord" is required in * the URL, for forms. Example: "pagetype=entityrecord" */ @@ -2325,7 +2325,7 @@ declare module Xrm * Additional parameters can be provided to the request. This can only be used to provide * default field values for the form, or pass data to custom parameters that have been * customized for the form. See example below for setting the selected form. - * + * * @remarks Example: encodeURIComponent( "formid={8c9f3e6f-7839-e211-831e-00155db7d98f}" ); */ extraqs?: string; @@ -2349,9 +2349,9 @@ declare module Xrm /** * Interface for defining parameters on a request to open a view with main.aspx (as with - * window.open). Useful for parsing the keys and values into a string of the format: + * window.open). Useful for parsing the keys and values into a string of the format: * "&key=value". - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. * * @remarks A member for "pagetype" is not provided. The value "entitylist" is required in @@ -2397,9 +2397,9 @@ declare module Xrm /** * Interface for defining parameters of a request to open a dialog with rundialog.aspx (as with - * window.open). Useful for parsing the keys and values into a string of the format: + * window.open). Useful for parsing the keys and values into a string of the format: * "&key=value". - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ export interface DialogOpenParameters @@ -2425,7 +2425,7 @@ declare module Xrm * Interface for defining parameters of a request to open a report with viewer.apsx (as with * window.open). Useful for parsing out the keys and values into a string of the format: * "&key=value" - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328483.aspx} for details. */ export interface ReportOpenParameters @@ -2433,7 +2433,7 @@ declare module Xrm /** * The action to perform, as either "run" or "filter". * - * @remarks "run" Executes the report with default filters. + * @remarks "run" Executes the report with default filters. * "filter" Presents the user with the filter editor, and a "Run Report" button. */ action: string; @@ -2453,7 +2453,7 @@ declare module Xrm /** * The Xrm.Utility API - * + * * @see {@link http://msdn.microsoft.com/en-us/library/gg328255.aspx|Documentation} for details. */ export module Utility @@ -2571,7 +2571,7 @@ declare module Xrm * @param {number} height (Optional) The height of the new window. * * @return A Window reference, containing the opened Web Resource. - * + * * @remarks This function will not work with Microsoft Dynamics CRM for tablets. * Valid WebResource URL Parameters: typename * type @@ -2588,7 +2588,7 @@ declare module Xrm /** * Gets the xRM application context, for HTML web resources, included by ClientGlobalContext.js.aspx * @returns {Xrm.Context} The application context for the user's current session. - * @remarks The ClientGlobalContext.js.aspx page will include some global event handlers. These event handlers will + * @remarks The ClientGlobalContext.js.aspx page will include some global event handlers. These event handlers will * cancel the onselectstart, contextmenu, and ondragstart events. */ declare function GetGlobalContext(): Xrm.Context;