CRM 2015 Client API Xrm Utility Xrm Page

CRM 2015 Client API Xrm. Utility Xrm. Page. data Parameters Description alert. Dialog message, on. Close. Callback? confirm. Dialog message, yes. Close. Callback? , no. Close. Callback? Displays a dialog box containing an applicationdefined message. Displays a confirmation dialog box that contains an optional message as well as OK and Cancel buttons. is. Activity. Type entity. Name Determine if an entity is an activity entity. open. Entity. Form name, id? , parameters? , window. Options? Opens an entity form for a new or existing entity record using the options you set as parameters. window. Options is only available 2015 Online Update 1+ open. Quick. Create callback? , entity. Logical. Name, create. From. Entity? , Opens a new quick create form. 2015 Online Update parameters? 1+ open. Web. Resourc web. Resource. Name, web. Resource. Data? , width? , Opens an HTML web resource. Does not work on e height? Tablets Xrm. Page. data. entity Parameters Description refresh save? save. Options? Asynchronously refreshes and optionally saves all the data of the form without reloading the page. Saves the record asynchronously. save. Options is only available 2015 Online Update 1+ then success. Callback? , error. Callback? Method is appended to above calls. Xrm. Page. data. entity attribute/Xrm. Page. get. Attribute Parameters Description controls A collection of all the controls representing the attribute. get. Attribute. Type Returns a string value that represents the type of attribute. get. Format Returns a string value of formatting options for the attribute. Returns a bool that indicates if there are unsaved changes. get. Is. Dirty Parameters Description get. Attribute schema. Name Retrieves an attribute from the Xrm. Page. data. entity. attributes collection get. Name Returns a number indicating the max length of a string or memo. Returns the logical name of the attribute. get. Control Id Retrieves a control from the Xrm. Page. ui. controls collection. get. Parent Returns the Xrm. Page. data. entity object. get. User. Privilege Returns an object with 3 bools indicating privileges of create, read, and update. Sets a function to be called when the value is changed. Xrm. Page. context Parameters Description client. get. Client Returns a value to indicate which client the script is executing in. client. get. Client. State Returns a value to indicate the state of the client. get. Client. Url Returns the base URL what was used to access the application. get. Current. Theme Returns a string representing the current Microsoft Office Outlook theme chosen by the user. Returns whether Autosave is enabled for the organization. get. Is. Auto. Save. Enabled get. Org. Lcid get. Org. Unique. Name get. Query. String. Parameters get. Time. Zone. Offset. Minutes get. User. Id get. User. Lcid get. User. Roles prepend. Org. Name s. Path add. On. Change add. On. Save remove. On. Change remove. On. Save fire. On. Change Returns a dictionary object of key value pairs that represents the query string arguments that were passed to the page. Returns the difference between the local time and Coordinated Universal Time (UTC). Returns the GUID of the System. User. Id value for the current user. Option. Set/Boolean set. Required. Level Returns and array of strings that represent the GUID values of each of the security roles that the user is associated with or any teams the user is associated with. Prepends the organization name to the specified path. Collections get. Text set. Value value get. Entity. Name Returns a string representing the XML that will be sent to the server when the record is saved. Does not work on Tablets Returns the logical name of the entity for the record get. Id Returns the id value for the record. get. Is. Dirty Returns a bool that indicates if any fields have been modified. add. On. Save Adds a function to be called when the record is saved. remove. On. Save Removes a function to be called when the record is saved. get. Primary. Attribute. Value Gets a string for the value of the primary attribute of the entity Saves the record synchronously with the option to close or open a new form after completed. save action? Xrm. Page. data. process Parameters get. Active. Process set. Active. Process Returns a Process object representing the active process. Id, callback. Function? get. Active. Stage set. Active. Stage Returns value currently selected option. Sets the datatext value for of anthe attribute. Returns a Stage object representing the active stage. Id, callback. Function? get. Enabled. Processes callback. Function move. Next callback. Function? Set a completed stage for the current entity as the active stage. Returns a collection of stages for the current, branched BPF. Asynchronously returns enabled BPFs. Callback must accept object. Progresses to the next stage. move. Previous callback. Function? Moves to the previous stage. add. On. Stage. Change Sets a function to be called when stage is changed. remove. On. Stage. Change Removes a function from the On. Stage. Change event. add. On. Stage. Selected Sets a function to be called when stage is selected. remove. On. Stage. Selected Removes a function from the On. Stage. Selected event. Process get. Id Returns the ID of the process. get. Name Returns the name of the process. get. Stages Returns a collection of Stages. is. Rendered Returns true if the process is rendered, false if not. Stage get. Min Returns a number indicating the minimum allowed value. get. Entityname Returns an object with a get. Value method to return the integer value of the category Returns the logical of the associated entity. get. Precision Returns the number of digits to the right of the decimal point. get. Id Returns the ID of the stage. get. Name Returns the name of the stage. get. Status Returns the status of the stage. get. Steps Returns a collection of steps in the stage. Apply an action in a delegate function to each object in the collection. get. Is. Party. List get value Get one or more objects from the collection. Returns a bool that indicates if the lookup is a partylist. get. Category Steps get. Attribute Get. Global. Context get. Name Returns the logical name of the attribute associated with the step. Returns the name of the step. is. Required Returns whether the step is required in the BPF Description Returns client-side context object. get. Depth Returns a value indicating when the handler is executed. get. Event. Args Returns an object with methods to manage the Save event. get. Event. Source Returns a reference to the object that the event occurred on. get. Shared. Variable Returns a variable set using set. Shared. Variable Sets the value of a variable to be used by the next handler. Set a process as the active process. Returns a number indicating the max allowed value. delegate function get. Context Description get. Max for. Each Parameters get. Data. Xml Retrieves the data value for an attribute. Lookup Execution Context A collection of all the entities attributes/fields get. Value Number Description Gets the number of items in the collection. Causes the On. Change event to occur. get. Selected. Option get. Submit. Mode set. Submit. Mode get. Options Parameters get. Length Removes a function from the On. Change event. requirement. Level Sets whether data is “required”, “recommended”, or “none”. Returns the value set when the form opened. Returns a string indicating the requirement level for an value Returns an option object with the value matching the attribute. argument passed. submit. Mode Sets when the data will be submitted Returns an array of option objects. (“always”, ”never”, ”dirty”). Returns the option object for thethe selected option. a string indicating when data will be submitted. get. Initial. Value get. Required. Level get. Option attributes get. Active. Path Returns the LCID value that represents the base language for the organization. Returns the unique text value of the organization’s name. Returns the LCID value that represents the Language Pack that the user selected as their preferred language. Returns the name of the current user. get. User. Name get. Max. Length Parameters Description Client. Global. Context. js. aspx

Xrm. Page. ui tab Xrm. Page. ui Parameters Description Parameters close Method to close the form. get. Display. State controls A collection of all the controls on the page set. Display. State form. Selector. items get. Form. Type A collection of all the form items accessible to the current user. Method to return a reference to the form currently being shown. Method to get the control object that currently has focus on the form. Method to get the form context for the record. navigation. items A collection of all the navigation items on the page form. Selector. get. Current. Item get. Current. Control set. Form. Notification message, level, unique. Id Use this method to display form level notification. clear. Form. Notification unique. Id refresh. Ribbon Use this method to remove form level notifications Xrm. Page. ui. navigation item Parameters Description Returns a value that indicates whether a tab is collapsed or expanded. get. Id Returns the name of the item. Sets the tab to be “collapsed” or “expanded”. get. Label Returns the label for the item. get. Name Returns the name of the tab. set. Label get. Parent Returns the Xrm. Page. ui object. set. Focus Sets the focus on the item. get. Label Returns the tab label. get. Visible Returns a value that indicates whether the item is visible. Sets the label for the tab. set. Visible set. Label string sections A collection of all the sections in the tab. set. Focus Sets the focus on the tab. get. Visible Returns a value that indicates whether the tab is visible. set. Visible bool Sets a value that indicates whether the tab is visible. Xrm. Page. ui section string Sets the label for the item. bool Sets a value that indicates whether the item is visible. Xrm. Page. ui. form. Selector item Parameters Description get. Id Returns the ID of the form. get. Label Returns the form label. navigate Opens the specified form. tabs Method to cause the ribbon to re-evaluate data that controls what is displayed in it. A collection of all the tabs on the page. get. View. Port. Height Method to get the height of the viewport in pixels controls A collection of controls in the section. get. View. Port. Width Method to get the width of the viewport in pixels get. Name Returns the name of the setction. get. Parent Returns the tab containing the section set. Display. State str. Expanded Sets the BPF control to be “collapsed” or “expanded”. get. Label Returns the section label. set. Visible Sets the BPF control to be visible or hidden. Xrm. Page. ui control/Xrm. Page. get. Control Parameters get. Disabled set. Disabled bool Description Parameters set. Label Returns whether the control is disabled. get. Visible Sets whether the control is disabled. set. Visible string Description Sets the label for the section. Returns a value that indicates whether the section is visible. bool Xrm. Page. ui. process Parameters Description bool. Visible Save event arguments Parameters Sets a value that indicates whether the section is visible. Description get. Attribute Returns the attribute that the control is bound to. get. Save. Mode Returns a value indicating how the save event was initiated. get. Control. Type Returns a value that categorizes controls. is. Default. Prevented get. Name Returns the name assigned to the control. Sub. Grid get. Parent Returns a reference to the section object that contains the control. Returns the label for the control. refresh Returns a value indicating whether the save event was canceled because of the prevent. Default method. Cancels the save operation, but all remaining events will be executed. Grid. Control get. Label Parameters Description Refreshes the data displayed in the subgrid. 2015 Online Update 1+ set. Label label Sets the label for the control. add. On. Load Used to add event handlers to the On. Load event. set. Notification message, unique. Id Display a message near the control for invalid data. get. Context. Type Returns context information about the control. clear. Notification unique. Id Remove a message already displayed for a control. get. Entity. Name bool Returns a value that indicates whether a control is visible. Sets whether the control is visible. get. Visible set. Focus Sets the focus on the control. Lookup add. Custom. Filter filter, entity. Logical. Name add. Custom. View Adds filter to the results displayed in the lookup. 1 Create (and Quick Create) 2 Save and Close get. Grid Returns the Grid object available in the control. 2 Update 59 Save and New get. View. Selector Returns the View. Selector object available in the control. 3 Read Only 70 Auto. Save remove. On. Load Removes event handlers from the On. Load event. 4 Disabled 58 Save as Completed Grid 2015 Online Update 1+ Returns a collection of every selected Grid. Row in the Grid. get. Default. View get. Total. Record. Count Returns the total number of records in the Grid. set. Default. View view. Guid Sets the default view for the lookup dialog box. Grid. Row Used to apply changes to lookups based on values when the user is about to view results. Removes a function from the Pre. Search event. get. Data option, [index] number get. Show. Time set. Show. Time bool get. Entity. Name Returns the logical name for the record in the row. get. Entity. Reference Returns a lookup object for the record in the row. get. Id Returns the id for the record in the row. get. Primary. Attribute. Value Returns the primary attribute value for the record. Sets whether a date control should show the time portion. Web. Resource get. Data set. Data Returns a reference to the current view. is. Visible Returns true if view selector is visible, false if not. view. Selector. Item string Sets the value of the data query string parameter. View. Selector. Item 2015 Online Update 1+ get. Entity. Reference string Returns the object in the form that represents the web resource. Sets the URL to be displayed. Returns the current URL being displayed. add. On. Result. Open Adds an event handler to the On. Result. Open event. add. On. Selection Adds an event handler to the On. Selection event. get. Search. Query Returns the text used as the search criteria. get. Selected. Result Returns the currently selected result. remove. On. Result. Open Removes a function from the On. Result. Open event. remove. On. Selection Removes a function from the On. Selection event. IFrame get. Initial. Url get. Object get. Src get. Current. View string Returns the default URL than an Iframe control is configured to display. Returns the object in the form that represents an IFrame Sets the URL to be displayed. Returns the current URL being displayed. kbsearch set. Search. Query 16 Qualify 15 Disqualify Xrm Utility Page context data 2015 Online Update 1+ set. Current. View get. Src set. Src View. Selector 2015 Online Update 1+ Returns the value of the data query string parameter. get. Object set. Src Returns the Grid. Entity for the Grid. Row. Data. Clears all options from an option set control. Get whether a date control shows the time portion. 7 Send 2015 Online Update 1+ Grid. Entity Date. Time 47 Assign Returns the Grid. Row. Data for the Grid. Row. Adds an option to an option set control. Removes an option from an option set control. 6 Reactivate 2015 Online Update 1+ get. Entity clear. Options remove. Option Grid. Row. Data 5 Deactivate 6 Bulk Edit get. Selected. Rows add. Option Value Text Returns the logical name of the entity data displayed. view. Id, entity. Name, view. Display. Na Adds a new view for the lookup dialog box. me, fetch. Xml, layout. Xml, is. Default Returns the ID value of the default lookup dialog view. Option. Set . get. Save. Mode() 1 Save Returns a collection of every Grid. Row in the Grid. remove. Pre. Search . get. Form. Type() 0 Undefinied get. Rows add. Pre. Search prevent. Default entity process attribute Process ui navigation Sets the current view. Returns a lookup object for the view. tab item process 2015 Online Update 1+ Requires Parature integration string Sets the text used as the search criteria. Stage Steps control section form. Selector item