From c4f9db7d85939c7723d5b2faeeb758e433757100 Mon Sep 17 00:00:00 2001 From: Ahash Sritharan Date: Thu, 16 May 2024 08:54:08 +0200 Subject: [PATCH] Removed tracking docs, updated readme --- .gitignore | 3 +- README.md | 14 +- READMEDOCS.md | 13 +- build/README.md | 14 +- docs/.nojekyll | 1 - docs/assets/highlight.css | 134 - docs/assets/main.js | 58 - docs/assets/search.js | 1 - docs/assets/style.css | 1367 ----- .../src_XrmEx.XrmEx.Class.BooleanField.html | 716 --- .../src_XrmEx.XrmEx.Class.DateField.html | 694 --- docs/classes/src_XrmEx.XrmEx.Class.Field.html | 684 --- .../src_XrmEx.XrmEx.Class.GridControl.html | 529 -- .../src_XrmEx.XrmEx.Class.LookupField.html | 953 ---- ...XrmEx.Class.MultiSelectOptionSetField.html | 803 --- .../src_XrmEx.XrmEx.Class.NumberField.html | 763 --- .../src_XrmEx.XrmEx.Class.OptionsetField.html | 880 --- .../src_XrmEx.XrmEx.Class.Section.html | 287 - docs/classes/src_XrmEx.XrmEx.Class.Tab.html | 399 -- .../src_XrmEx.XrmEx.Class.TextField.html | 713 --- docs/classes/src_XrmEx.XrmEx.Fields.html | 456 -- docs/classes/src_XrmEx.XrmEx.Form.html | 382 -- docs/classes/src_XrmEx.XrmEx.Process.html | 511 -- ...m.XrmEnum.AdvancedConfigSettingOption.html | 126 - ...ypes_xrm.XrmEnum.AppNotificationLevel.html | 142 - ...es_xrm.XrmEnum.AttributeRequiredLevel.html | 140 - ...xrm.XrmEnum.AttributeRequirementLevel.html | 136 - ...ules__types_xrm.XrmEnum.AttributeType.html | 191 - ...__types_xrm.XrmEnum.AttributeTypeCode.html | 259 - ...ode_modules__types_xrm.XrmEnum.Client.html | 149 - ...s__types_xrm.XrmEnum.ClientFormFactor.html | 136 - ...odules__types_xrm.XrmEnum.ClientState.html | 128 - ...ules__types_xrm.XrmEnum.CmdBarDisplay.html | 128 - ...types_xrm.XrmEnum.DateAttributeFormat.html | 128 - ..._types_xrm.XrmEnum.DevicePickFileType.html | 135 - ...dules__types_xrm.XrmEnum.DisplayState.html | 128 - ...les__types_xrm.XrmEnum.EntitySaveMode.html | 132 - ...__types_xrm.XrmEnum.FormDataLoadState.html | 135 - ...pes_xrm.XrmEnum.FormNotificationLevel.html | 135 - ...e_modules__types_xrm.XrmEnum.FormType.html | 174 - ...modules__types_xrm.XrmEnum.GridClient.html | 126 - ..._types_xrm.XrmEnum.GridControlContext.html | 147 - ...es_xrm.XrmEnum.IntegerAttributeFormat.html | 128 - ...ules__types_xrm.XrmEnum.NavBarDisplay.html | 135 - ...es__types_xrm.XrmEnum.OpenFileOptions.html | 126 - ...ypes_xrm.XrmEnum.OpenSearchResultMode.html | 122 - ..._xrm.XrmEnum.OptionSetAttributeFormat.html | 128 - ...ules__types_xrm.XrmEnum.ProcessStatus.html | 135 - ...s__types_xrm.XrmEnum.RelationshipType.html | 126 - ...dules__types_xrm.XrmEnum.ReportAction.html | 128 - ...e_modules__types_xrm.XrmEnum.RoleType.html | 126 - ...e_modules__types_xrm.XrmEnum.SaveMode.html | 189 - ...ules__types_xrm.XrmEnum.StageCategory.html | 161 - ...ypes_xrm.XrmEnum.StageChangeDirection.html | 128 - ...odules__types_xrm.XrmEnum.StageStatus.html | 128 - ...types_xrm.XrmEnum.StandardControlType.html | 198 - ...pes_xrm.XrmEnum.StringAttributeFormat.html | 156 - ...modules__types_xrm.XrmEnum.SubmitMode.html | 135 - ...node_modules__types_xrm.XrmEnum.Theme.html | 135 - ...e_modules__types_xrm.XrmEnum.ViewType.html | 126 - ...es__types_xrm.XrmEnum.WindowPositions.html | 126 - ...e_modules__types_xrm.GetGlobalContext.html | 64 - ...src_XrmEx.XrmEx.addGlobalNotification.html | 95 - docs/functions/src_XrmEx.XrmEx.asPromise.html | 98 - ...XrmEx.XrmEx.checkRequestParameterType.html | 86 - .../src_XrmEx.XrmEx.executeAction.html | 99 - .../src_XrmEx.XrmEx.executeFunction.html | 99 - ...mEx.XrmEx.getEnvironmentVariableValue.html | 87 - .../src_XrmEx.XrmEx.getFunctionName.html | 77 - .../src_XrmEx.XrmEx.normalizeGuid.html | 85 - .../src_XrmEx.XrmEx.openAlertDialog.html | 90 - ..._XrmEx.XrmEx.removeGlobalNotification.html | 85 - .../functions/src_XrmEx.XrmEx.throwError.html | 86 - docs/index.html | 177 - .../node_modules__types_xrm.Window.html | 4696 ----------------- .../node_modules__types_xrm.Xrm.App-1.html | 267 - ...ode_modules__types_xrm.Xrm.App.Action.html | 176 - ...dules__types_xrm.Xrm.App.Notification.html | 198 - ...modules__types_xrm.Xrm.App.PaneObject.html | 287 - ...odules__types_xrm.Xrm.App.PaneOptions.html | 248 - ..._modules__types_xrm.Xrm.AppProperties.html | 194 - ...pes_xrm.Xrm.Async.ErrorCallbackObject.html | 169 - ....Xrm.Async.OfflineErrorCallbackObject.html | 181 - ...OfflineOperationSuccessCallbackObject.html | 167 - ....OpenQuickCreateSuccessCallbackObject.html | 157 - ...ules__types_xrm.Xrm.Async.PromiseLike.html | 365 -- ...s__types_xrm.Xrm.Attributes.Attribute.html | 504 -- ...s_xrm.Xrm.Attributes.BooleanAttribute.html | 521 -- ...ypes_xrm.Xrm.Attributes.DateAttribute.html | 499 -- ...ypes_xrm.Xrm.Attributes.EnumAttribute.html | 537 -- ...es_xrm.Xrm.Attributes.LookupAttribute.html | 529 -- ...ributes.MultiSelectOptionSetAttribute.html | 600 --- ...es_xrm.Xrm.Attributes.NumberAttribute.html | 564 -- ...xrm.Xrm.Attributes.OptionSetAttribute.html | 607 --- ...es_xrm.Xrm.Attributes.StringAttribute.html | 517 -- .../node_modules__types_xrm.Xrm.Calendar.html | 187 - ..._modules__types_xrm.Xrm.ClientContext.html | 205 - ...__types_xrm.Xrm.Collection.Dictionary.html | 143 - ...pes_xrm.Xrm.Collection.ItemCollection.html | 301 -- ...ules__types_xrm.Xrm.CommandProperties.html | 190 - ...ontrols.AddControlNotificationOptions.html | 230 - ..._xrm.Xrm.Controls.AutoCompleteCommand.html | 241 - ...s_xrm.Xrm.Controls.AutoCompleteResult.html | 223 - ...rm.Xrm.Controls.AutoCompleteResultSet.html | 213 - ...es_xrm.Xrm.Controls.AutoLookupControl.html | 706 --- ...types_xrm.Xrm.Controls.BooleanControl.html | 544 -- ...dules__types_xrm.Xrm.Controls.Control.html | 325 -- ...rm.Controls.ControlNotificationAction.html | 221 - ...s__types_xrm.Xrm.Controls.DateControl.html | 579 -- ...s_xrm.Xrm.Controls.FieldControlOutput.html | 197 - ..._types_xrm.Xrm.Controls.FooterSection.html | 229 - ...ules__types_xrm.Xrm.Controls.FormItem.html | 271 - ...__types_xrm.Xrm.Controls.FormSelector.html | 226 - ..._types_xrm.Xrm.Controls.FramedControl.html | 397 -- ...odules__types_xrm.Xrm.Controls.Grid-1.html | 241 - ...ypes_xrm.Xrm.Controls.Grid.GridEntity.html | 270 - ...__types_xrm.Xrm.Controls.Grid.GridRow.html | 233 - ...pes_xrm.Xrm.Controls.Grid.GridRowData.html | 217 - ...s__types_xrm.Xrm.Controls.GridControl.html | 546 -- ...pes_xrm.Xrm.Controls.GridRelationship.html | 241 - ..._types_xrm.Xrm.Controls.HeaderSection.html | 313 -- ..._types_xrm.Xrm.Controls.IframeControl.html | 436 -- ...ypes_xrm.Xrm.Controls.KbSearchControl.html | 543 -- ...types_xrm.Xrm.Controls.KbSearchResult.html | 365 -- ..._types_xrm.Xrm.Controls.LookupControl.html | 792 --- ....Controls.MultiSelectOptionSetControl.html | 607 --- ...es__types_xrm.Xrm.Controls.Navigation.html | 205 - ...types_xrm.Xrm.Controls.NavigationItem.html | 304 -- ..._types_xrm.Xrm.Controls.NumberControl.html | 678 --- ...pes_xrm.Xrm.Controls.OptionSetControl.html | 609 --- ...types_xrm.Xrm.Controls.ProcessControl.html | 298 -- ...pes_xrm.Xrm.Controls.QuickFormControl.html | 524 -- ...dules__types_xrm.Xrm.Controls.Section.html | 320 -- ...s_xrm.Xrm.Controls.SilverlightControl.html | 382 -- ...ypes_xrm.Xrm.Controls.StandardControl.html | 566 -- ..._types_xrm.Xrm.Controls.StringControl.html | 680 --- ...e_modules__types_xrm.Xrm.Controls.Tab.html | 417 -- ...__types_xrm.Xrm.Controls.TimelineWall.html | 333 -- ....Xrm.Controls.UiCanGetDisabledElement.html | 208 - ...m.Xrm.Controls.UiCanGetVisibleElement.html | 211 - ....Xrm.Controls.UiCanSetDisabledElement.html | 215 - ...m.Xrm.Controls.UiCanSetVisibleElement.html | 218 - ...s__types_xrm.Xrm.Controls.UiFocusable.html | 210 - ...types_xrm.Xrm.Controls.UiKeyPressable.html | 264 - ...types_xrm.Xrm.Controls.UiLabelElement.html | 231 - ...es_xrm.Xrm.Controls.UiStandardElement.html | 273 - ...__types_xrm.Xrm.Controls.ViewSelector.html | 243 - ...pes_xrm.Xrm.Controls.ViewSelectorItem.html | 208 - ...modules__types_xrm.Xrm.CreateResponse.html | 152 - .../node_modules__types_xrm.Xrm.Data.html | 315 -- ...les__types_xrm.Xrm.DateFormattingInfo.html | 299 -- .../node_modules__types_xrm.Xrm.Device-1.html | 235 - ...es_xrm.Xrm.Device.CaptureFileResponse.html | 187 - ...es_xrm.Xrm.Device.CaptureImageOptions.html | 197 - ...Xrm.Device.GetCurrentPositionResponse.html | 167 - ..._types_xrm.Xrm.Device.PickFileOptions.html | 177 - .../node_modules__types_xrm.Xrm.Encoding.html | 250 - .../node_modules__types_xrm.Xrm.Entity.html | 392 -- ...__types_xrm.Xrm.EntityFormPageContext.html | 190 - ...__types_xrm.Xrm.EntityListPageContext.html | 180 - ...odules__types_xrm.Xrm.EntityReference.html | 184 - ..._modules__types_xrm.Xrm.ErrorResponse.html | 152 - ...m.Events.Attribute.ChangeEventContext.html | 321 -- ...xrm.Xrm.Events.DataLoadEventArguments.html | 187 - ...s_xrm.Xrm.Events.DataLoadEventContext.html | 327 -- ...es__types_xrm.Xrm.Events.EventContext.html | 321 -- ...m.Events.GridControl.LoadEventContext.html | 321 -- ...bSearchControl.PostSearchEventContext.html | 325 -- ...earchControl.ResultOpenedEventContext.html | 325 -- ...KbSearchControl.SelectionEventContext.html | 325 -- ...pes_xrm.Xrm.Events.LoadEventArguments.html | 189 - ...rm.Xrm.Events.LoadEventArgumentsAsync.html | 212 - ...types_xrm.Xrm.Events.LoadEventContext.html | 332 -- ..._xrm.Xrm.Events.LoadEventContextAsync.html | 330 -- ...m.Events.LookupTagClickEventArguments.html | 213 - ...Xrm.Events.LookupTagClickEventContext.html | 328 -- ...ts.ProcessStatusChangedEventArguments.html | 216 - ...ents.ProcessStatusChangedEventContext.html | 329 -- ...pes_xrm.Xrm.Events.SaveEventArguments.html | 249 - ...rm.Xrm.Events.SaveEventArgumentsAsync.html | 275 - ...types_xrm.Xrm.Events.SaveEventContext.html | 333 -- ..._xrm.Xrm.Events.SaveEventContextAsync.html | 330 -- ....Xrm.Events.StageChangeEventArguments.html | 218 - ...rm.Xrm.Events.StageChangeEventContext.html | 325 -- ...rm.Events.StageSelectedEventArguments.html | 191 - ....Xrm.Events.StageSelectedEventContext.html | 331 -- ...odules__types_xrm.Xrm.ExecuteResponse.html | 328 -- ...de_modules__types_xrm.Xrm.FormContext.html | 380 -- ..._modules__types_xrm.Xrm.GlobalContext.html | 520 -- ...es__types_xrm.Xrm.LookupFilterOptions.html | 158 - ..._modules__types_xrm.Xrm.LookupOptions.html | 231 - ...de_modules__types_xrm.Xrm.LookupValue.html | 171 - ...es_xrm.Xrm.Metadata.AttributeMetadata.html | 195 - ...types_xrm.Xrm.Metadata.EntityMetadata.html | 535 -- ...modules__types_xrm.Xrm.Metadata.Label.html | 164 - ...types_xrm.Xrm.Metadata.LocalizedLabel.html | 161 - ...types_xrm.Xrm.Metadata.OptionMetadata.html | 217 - .../node_modules__types_xrm.Xrm.Mobile.html | 155 - ..._modules__types_xrm.Xrm.MobileOffline.html | 387 -- ...e_modules__types_xrm.Xrm.Navigation-1.html | 333 -- ...types_xrm.Xrm.Navigation.AlertStrings.html | 185 - ...ypes_xrm.Xrm.Navigation.ConfirmResult.html | 169 - ...pes_xrm.Xrm.Navigation.ConfirmStrings.html | 205 - ...__types_xrm.Xrm.Navigation.CustomPage.html | 192 - ...s__types_xrm.Xrm.Navigation.Dashboard.html | 172 - ..._xrm.Xrm.Navigation.DialogSizeOptions.html | 177 - ..._xrm.Xrm.Navigation.EntityFormOptions.html | 338 -- ...xrm.Xrm.Navigation.ErrorDialogOptions.html | 192 - ..._types_xrm.Xrm.Navigation.FileDetails.html | 195 - ...rm.Xrm.Navigation.NavigationOptions-1.html | 208 - ...avigation.NavigationOptions.SizeValue.html | 180 - ...pes_xrm.Xrm.Navigation.OpenFormResult.html | 165 - ...Xrm.Navigation.OpenWebresourceOptions.html | 189 - ...rm.Xrm.Navigation.PageInputEntityList.html | 192 - ....Xrm.Navigation.PageInputEntityRecord.html | 287 - ...m.Navigation.PageInputHtmlWebResource.html | 182 - ...types_xrm.Xrm.Navigation.Relationship.html | 213 - ...modules__types_xrm.Xrm.OptionSetValue.html | 160 - ...s__types_xrm.Xrm.OrganizationSettings.html | 232 - .../node_modules__types_xrm.Xrm.Page-1.html | 410 -- ...rm.Page.AddControlNotificationOptions.html | 260 - ...modules__types_xrm.Xrm.Page.Attribute.html | 564 -- ...ypes_xrm.Xrm.Page.AutoCompleteCommand.html | 269 - ...types_xrm.Xrm.Page.AutoCompleteResult.html | 250 - ...es_xrm.Xrm.Page.AutoCompleteResultSet.html | 239 - ..._types_xrm.Xrm.Page.AutoLookupControl.html | 725 --- ...__types_xrm.Xrm.Page.BooleanAttribute.html | 572 -- ...e_modules__types_xrm.Xrm.Page.Control.html | 342 -- ...rm.Xrm.Page.ControlNotificationAction.html | 247 - ...les__types_xrm.Xrm.Page.DateAttribute.html | 550 -- ...dules__types_xrm.Xrm.Page.DateControl.html | 586 -- ...de_modules__types_xrm.Xrm.Page.Entity.html | 481 -- ...les__types_xrm.Xrm.Page.EnumAttribute.html | 585 -- ...ules__types_xrm.Xrm.Page.EventContext.html | 349 -- ..._modules__types_xrm.Xrm.Page.FormItem.html | 300 -- ...ules__types_xrm.Xrm.Page.FormSelector.html | 252 - ...les__types_xrm.Xrm.Page.FramedControl.html | 422 -- ...dules__types_xrm.Xrm.Page.GridControl.html | 575 -- ...les__types_xrm.Xrm.Page.IframeControl.html | 458 -- ...s__types_xrm.Xrm.Page.LookupAttribute.html | 581 -- ...les__types_xrm.Xrm.Page.LookupControl.html | 824 --- ...dules__types_xrm.Xrm.Page.LookupValue.html | 250 - ...odules__types_xrm.Xrm.Page.Navigation.html | 230 - ...es__types_xrm.Xrm.Page.NavigationItem.html | 325 -- ...s__types_xrm.Xrm.Page.NumberAttribute.html | 619 --- ...les__types_xrm.Xrm.Page.NumberControl.html | 720 --- ...types_xrm.Xrm.Page.OptionSetAttribute.html | 658 --- ...__types_xrm.Xrm.Page.OptionSetControl.html | 634 --- ...es__types_xrm.Xrm.Page.OptionSetValue.html | 239 - ...modules__types_xrm.Xrm.Page.Privilege.html | 250 - ...e_modules__types_xrm.Xrm.Page.Process.html | 282 - ...types_xrm.Xrm.Page.SaveEventArguments.html | 363 -- ...__types_xrm.Xrm.Page.SaveEventContext.html | 363 -- ...e_modules__types_xrm.Xrm.Page.Section.html | 341 -- ...types_xrm.Xrm.Page.SilverlightControl.html | 404 -- ...ode_modules__types_xrm.Xrm.Page.Stage.html | 320 -- ...rm.Xrm.Page.StageChangeEventArguments.html | 261 - ..._xrm.Xrm.Page.StageChangeEventContext.html | 364 -- ....Xrm.Page.StageSelectedEventArguments.html | 232 - ...rm.Xrm.Page.StageSelectedEventContext.html | 364 -- ...s__types_xrm.Xrm.Page.StandardControl.html | 588 --- ...node_modules__types_xrm.Xrm.Page.Step.html | 268 - ...s__types_xrm.Xrm.Page.StringAttribute.html | 569 -- ...les__types_xrm.Xrm.Page.StringControl.html | 702 --- .../node_modules__types_xrm.Xrm.Page.Tab.html | 441 -- ...ules__types_xrm.Xrm.Page.TimelineWall.html | 356 -- ...s_xrm.Xrm.Page.UiCanGetVisibleElement.html | 232 - ...s_xrm.Xrm.Page.UiCanSetVisibleElement.html | 239 - ...dules__types_xrm.Xrm.Page.UiFocusable.html | 231 - ...es__types_xrm.Xrm.Page.UiKeyPressable.html | 290 - ...es__types_xrm.Xrm.Page.UiLabelElement.html | 254 - ..._types_xrm.Xrm.Page.UiStandardElement.html | 291 - ...s_xrm.Xrm.Page.data.ProcessDictionary.html | 213 - ...ypes_xrm.Xrm.Page.data.ProcessManager.html | 808 --- ...e_modules__types_xrm.Xrm.Page.ui.Grid.html | 281 - ...les__types_xrm.Xrm.Page.ui.GridEntity.html | 303 -- ...odules__types_xrm.Xrm.Page.ui.GridRow.html | 266 - ...es__types_xrm.Xrm.Page.ui.GridRowData.html | 249 - ..._types_xrm.Xrm.Page.ui.ProcessManager.html | 336 -- ...ules__types_xrm.Xrm.Page.ui.QuickForm.html | 561 -- ...s__types_xrm.Xrm.Page.ui.ViewSelector.html | 284 - ...ypes_xrm.Xrm.Page.ui.ViewSelectorItem.html | 247 - ...de_modules__types_xrm.Xrm.PageContext.html | 147 - .../node_modules__types_xrm.Xrm.Panel.html | 170 - ...node_modules__types_xrm.Xrm.Privilege.html | 170 - ...es__types_xrm.Xrm.ProcessFlow.Process.html | 217 - ...xrm.Xrm.ProcessFlow.ProcessDictionary.html | 145 - ...es_xrm.Xrm.ProcessFlow.ProcessManager.html | 714 --- ...ules__types_xrm.Xrm.ProcessFlow.Stage.html | 253 - ...dules__types_xrm.Xrm.ProcessFlow.Step.html | 200 - ..._types_xrm.Xrm.RetrieveMultipleResult.html | 158 - ...de_modules__types_xrm.Xrm.SaveOptions.html | 165 - .../node_modules__types_xrm.Xrm.TagValue.html | 183 - .../node_modules__types_xrm.Xrm.Ui.html | 454 -- ...ypes_xrm.Xrm.Url.DialogOpenParameters.html | 184 - ..._types_xrm.Xrm.Url.FormOpenParameters.html | 214 - ...ypes_xrm.Xrm.Url.ReportOpenParameters.html | 190 - ..._types_xrm.Xrm.Url.ViewOpenParameters.html | 226 - ...e_modules__types_xrm.Xrm.UserSettings.html | 292 - ...node_modules__types_xrm.Xrm.Utility-1.html | 628 --- ...es_xrm.Xrm.Utility.FormOpenParameters.html | 190 - ..._types_xrm.Xrm.Utility.OpenParameters.html | 136 - ...__types_xrm.Xrm.Utility.WindowOptions.html | 155 - .../node_modules__types_xrm.Xrm.WebApi.html | 382 -- ..._modules__types_xrm.Xrm.WebApiOffline.html | 327 -- ...e_modules__types_xrm.Xrm.WebApiOnline.html | 413 -- ...node_modules__types_xrm.Xrm.XrmStatic.html | 250 - .../node_modules__types_xrm.Xrm.App.html | 140 - .../node_modules__types_xrm.Xrm.Async.html | 139 - ...ode_modules__types_xrm.Xrm.Attributes.html | 169 - ...ode_modules__types_xrm.Xrm.Collection.html | 142 - ..._modules__types_xrm.Xrm.Controls.Grid.html | 185 - .../node_modules__types_xrm.Xrm.Controls.html | 235 - .../node_modules__types_xrm.Xrm.Device.html | 145 - ...dules__types_xrm.Xrm.Events.Attribute.html | 169 - ...les__types_xrm.Xrm.Events.GridControl.html | 169 - ..._types_xrm.Xrm.Events.KbSearchControl.html | 177 - .../node_modules__types_xrm.Xrm.Events.html | 197 - .../node_modules__types_xrm.Xrm.Metadata.html | 139 - ..._xrm.Xrm.Navigation.NavigationOptions.html | 149 - ...ode_modules__types_xrm.Xrm.Navigation.html | 169 - ...node_modules__types_xrm.Xrm.Page.data.html | 221 - .../node_modules__types_xrm.Xrm.Page.html | 282 - .../node_modules__types_xrm.Xrm.Page.ui.html | 229 - ...de_modules__types_xrm.Xrm.ProcessFlow.html | 152 - .../node_modules__types_xrm.Xrm.Url.html | 148 - .../node_modules__types_xrm.Xrm.Utility.html | 138 - docs/modules/node_modules__types_xrm.Xrm.html | 194 - .../node_modules__types_xrm.XrmEnum.html | 137 - docs/modules/node_modules__types_xrm.html | 70 - docs/modules/src_XrmEx.XrmEx.Class.html | 97 - docs/modules/src_XrmEx.XrmEx.html | 92 - docs/modules/src_XrmEx.html | 53 - ...es_xrm.Xrm.Attributes.AttributeFormat.html | 147 - ...ypes_xrm.Xrm.Attributes.AttributeType.html | 142 - ...rm.Xrm.Attributes.DateAttributeFormat.html | 142 - ...Xrm.Attributes.IntegerAttributeFormat.html | 142 - ...m.Attributes.OptionSetAttributeFormat.html | 142 - ...s_xrm.Xrm.Attributes.RequirementLevel.html | 143 - ....Xrm.Attributes.StringAttributeFormat.html | 142 - .../node_modules__types_xrm.Xrm.Client.html | 122 - ...de_modules__types_xrm.Xrm.ClientState.html | 122 - ..._xrm.Xrm.Collection.IterativeDelegate.html | 155 - ...s_xrm.Xrm.Collection.MatchingDelegate.html | 156 - ...lection.StringIndexableItemCollection.html | 136 - ...xrm.Xrm.Controls.ControlQuickFormType.html | 173 - ...s__types_xrm.Xrm.Controls.ControlType.html | 175 - ...es_xrm.Xrm.Controls.NotificationLevel.html | 173 - ...s__types_xrm.Xrm.Device.PickFileTypes.html | 131 - ...e_modules__types_xrm.Xrm.DisplayState.html | 122 - ...modules__types_xrm.Xrm.EntitySaveMode.html | 126 - ...m.Events.Attribute.ChangeEventHandler.html | 173 - ...rm.Xrm.Events.ContextSensitiveHandler.html | 173 - ...s_xrm.Xrm.Events.DataLoadEventHandler.html | 167 - ...m.Events.GridControl.LoadEventHandler.html | 173 - ...bSearchControl.PostSearchEventHandler.html | 177 - ...earchControl.ResultOpenedEventHandler.html | 177 - ...KbSearchControl.SelectionEventHandler.html | 177 - ...types_xrm.Xrm.Events.LoadEventHandler.html | 167 - ..._xrm.Xrm.Events.LoadEventHandlerAsync.html | 167 - ..._xrm.Xrm.Events.LookupTagClickHandler.html | 167 - ...s_xrm.Xrm.Events.PostSaveEventHandler.html | 167 - ...Xrm.Events.ProcessStatusChangeHandler.html | 167 - ...types_xrm.Xrm.Events.SaveEventHandler.html | 167 - ..._xrm.Xrm.Events.SaveEventHandlerAsync.html | 167 - ...rm.Xrm.Events.StageChangeEventHandler.html | 167 - ....Xrm.Events.StageSelectedEventHandler.html | 167 - ...__types_xrm.Xrm.FormNotificationLevel.html | 122 - ...s__types_xrm.Xrm.Page.AttributeFormat.html | 197 - ...les__types_xrm.Xrm.Page.AttributeType.html | 197 - ..._xrm.Xrm.Page.ContextSensitiveHandler.html | 199 - ...pes_xrm.Xrm.Page.ControlQuickFormType.html | 197 - ...dules__types_xrm.Xrm.Page.ControlType.html | 197 - ...ypes_xrm.Xrm.Page.DateAttributeFormat.html | 197 - ...s_xrm.Xrm.Page.IntegerAttributeFormat.html | 197 - ..._types_xrm.Xrm.Page.NotificationLevel.html | 197 - ...xrm.Xrm.Page.OptionSetAttributeFormat.html | 197 - ...les__types_xrm.Xrm.Page.ProcessStatus.html | 197 - ...m.Xrm.Page.ProcessStatusChangeHandler.html | 199 - ...__types_xrm.Xrm.Page.RequirementLevel.html | 197 - ..._modules__types_xrm.Xrm.Page.SaveMode.html | 197 - ...pes_xrm.Xrm.Page.StageChangeDirection.html | 197 - ...dules__types_xrm.Xrm.Page.StageStatus.html | 197 - ...es_xrm.Xrm.Page.StringAttributeFormat.html | 197 - ...odules__types_xrm.Xrm.Page.SubmitMode.html | 197 - ...Page.data.GetProcessInstancesDelegate.html | 219 - ...Xrm.Page.data.ProcessCallbackDelegate.html | 218 - ...rm.Page.data.ProcessSetStatusDelegate.html | 216 - ....Page.data.SetProcessInstanceDelegate.html | 215 - ...s__types_xrm.Xrm.Page.ui.DisplayState.html | 211 - ...xrm.Xrm.Page.ui.FormNotificationLevel.html | 211 - ...ocessFlow.GetProcessInstancesDelegate.html | 159 - ...m.ProcessFlow.ProcessCallbackDelegate.html | 161 - ....ProcessFlow.ProcessSetStatusDelegate.html | 152 - ...pes_xrm.Xrm.ProcessFlow.ProcessStatus.html | 138 - ...rocessFlow.SetProcessInstanceDelegate.html | 158 - ....Xrm.ProcessFlow.StageChangeDirection.html | 138 - ...types_xrm.Xrm.ProcessFlow.StageStatus.html | 138 - ...ode_modules__types_xrm.Xrm.SubmitMode.html | 122 - .../node_modules__types_xrm.Xrm.Theme.html | 124 - ...ules__types_xrm.Xrm.Url.CmdBarDisplay.html | 133 - ...ules__types_xrm.Xrm.Url.NavBarDisplay.html | 133 - ...dules__types_xrm.Xrm.Url.ReportAction.html | 133 - .../node_modules__types_xrm.Window-1.html | 65 - .../node_modules__types_xrm.Xrm-1.html | 54 - release/xrm-ex.zip | Bin 65343 -> 65303 bytes 406 files changed, 16 insertions(+), 112361 deletions(-) delete mode 100644 docs/.nojekyll delete mode 100644 docs/assets/highlight.css delete mode 100644 docs/assets/main.js delete mode 100644 docs/assets/search.js delete mode 100644 docs/assets/style.css delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.BooleanField.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.DateField.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.Field.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.GridControl.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.LookupField.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.NumberField.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.OptionsetField.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.Section.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.Tab.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Class.TextField.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Fields.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Form.html delete mode 100644 docs/classes/src_XrmEx.XrmEx.Process.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.AdvancedConfigSettingOption.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.AppNotificationLevel.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.AttributeRequiredLevel.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.AttributeRequirementLevel.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.AttributeType.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.AttributeTypeCode.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.Client.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.ClientFormFactor.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.ClientState.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.CmdBarDisplay.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.DateAttributeFormat.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.DevicePickFileType.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.DisplayState.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.EntitySaveMode.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.FormDataLoadState.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.FormNotificationLevel.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.FormType.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.GridClient.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.GridControlContext.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.IntegerAttributeFormat.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.NavBarDisplay.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.OpenFileOptions.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.OpenSearchResultMode.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.OptionSetAttributeFormat.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.ProcessStatus.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.RelationshipType.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.ReportAction.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.RoleType.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.SaveMode.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.StageCategory.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.StageChangeDirection.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.StageStatus.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.StandardControlType.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.StringAttributeFormat.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.SubmitMode.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.Theme.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.ViewType.html delete mode 100644 docs/enums/node_modules__types_xrm.XrmEnum.WindowPositions.html delete mode 100644 docs/functions/node_modules__types_xrm.GetGlobalContext.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.addGlobalNotification.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.asPromise.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.checkRequestParameterType.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.executeAction.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.executeFunction.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.getEnvironmentVariableValue.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.getFunctionName.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.normalizeGuid.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.openAlertDialog.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.removeGlobalNotification.html delete mode 100644 docs/functions/src_XrmEx.XrmEx.throwError.html delete mode 100644 docs/index.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Window.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.App-1.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.App.Action.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.App.Notification.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.App.PaneObject.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.App.PaneOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.AppProperties.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Async.ErrorCallbackObject.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Async.OfflineErrorCallbackObject.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Async.OfflineOperationSuccessCallbackObject.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Async.OpenQuickCreateSuccessCallbackObject.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Async.PromiseLike.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Attributes.Attribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Attributes.BooleanAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Attributes.DateAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Attributes.EnumAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Attributes.LookupAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Attributes.MultiSelectOptionSetAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Attributes.NumberAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Attributes.OptionSetAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Attributes.StringAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Calendar.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.ClientContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Collection.Dictionary.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Collection.ItemCollection.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.CommandProperties.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.AddControlNotificationOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteCommand.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteResult.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteResultSet.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoLookupControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.BooleanControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.Control.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.ControlNotificationAction.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.DateControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.FieldControlOutput.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.FooterSection.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.FormItem.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.FormSelector.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.FramedControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid-1.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridEntity.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridRow.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridRowData.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.GridControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.GridRelationship.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.HeaderSection.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.IframeControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.KbSearchControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.KbSearchResult.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.LookupControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.MultiSelectOptionSetControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.Navigation.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.NavigationItem.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.NumberControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.OptionSetControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.ProcessControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.QuickFormControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.Section.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.SilverlightControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.StandardControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.StringControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.Tab.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.TimelineWall.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanGetDisabledElement.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanGetVisibleElement.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanSetDisabledElement.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanSetVisibleElement.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiFocusable.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiKeyPressable.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiLabelElement.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiStandardElement.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.ViewSelector.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Controls.ViewSelectorItem.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.CreateResponse.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Data.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.DateFormattingInfo.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Device-1.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Device.CaptureFileResponse.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Device.CaptureImageOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Device.GetCurrentPositionResponse.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Device.PickFileOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Encoding.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Entity.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.EntityFormPageContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.EntityListPageContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.EntityReference.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.ErrorResponse.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.Attribute.ChangeEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.DataLoadEventArguments.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.DataLoadEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.EventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.GridControl.LoadEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.PostSearchEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.ResultOpenedEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.SelectionEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventArguments.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventArgumentsAsync.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventContextAsync.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.LookupTagClickEventArguments.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.LookupTagClickEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.ProcessStatusChangedEventArguments.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.ProcessStatusChangedEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventArguments.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventArgumentsAsync.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventContextAsync.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.StageChangeEventArguments.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.StageChangeEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.StageSelectedEventArguments.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Events.StageSelectedEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.ExecuteResponse.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.FormContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.GlobalContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.LookupFilterOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.LookupOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.LookupValue.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Metadata.AttributeMetadata.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Metadata.EntityMetadata.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Metadata.Label.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Metadata.LocalizedLabel.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Metadata.OptionMetadata.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Mobile.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.MobileOffline.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation-1.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.AlertStrings.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ConfirmResult.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ConfirmStrings.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.CustomPage.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.Dashboard.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.DialogSizeOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.EntityFormOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ErrorDialogOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.FileDetails.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.NavigationOptions-1.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.NavigationOptions.SizeValue.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.OpenFormResult.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.OpenWebresourceOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputEntityList.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputEntityRecord.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputHtmlWebResource.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Navigation.Relationship.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.OptionSetValue.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.OrganizationSettings.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page-1.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.AddControlNotificationOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.Attribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteCommand.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteResult.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteResultSet.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoLookupControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.BooleanAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.Control.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.ControlNotificationAction.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.DateAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.DateControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.Entity.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.EnumAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.EventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.FormItem.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.FormSelector.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.FramedControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.GridControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.IframeControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupValue.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.Navigation.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.NavigationItem.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.NumberAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.NumberControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetValue.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.Privilege.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.Process.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.SaveEventArguments.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.SaveEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.Section.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.SilverlightControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.Stage.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.StageChangeEventArguments.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.StageChangeEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.StageSelectedEventArguments.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.StageSelectedEventContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.StandardControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.Step.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.StringAttribute.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.StringControl.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.Tab.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.TimelineWall.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.UiCanGetVisibleElement.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.UiCanSetVisibleElement.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.UiFocusable.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.UiKeyPressable.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.UiLabelElement.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.UiStandardElement.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.data.ProcessDictionary.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.data.ProcessManager.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.Grid.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridEntity.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridRow.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridRowData.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ProcessManager.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.QuickForm.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ViewSelector.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ViewSelectorItem.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.PageContext.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Panel.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Privilege.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Process.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.ProcessDictionary.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.ProcessManager.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Stage.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Step.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.RetrieveMultipleResult.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.SaveOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.TagValue.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Ui.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Url.DialogOpenParameters.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Url.FormOpenParameters.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Url.ReportOpenParameters.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Url.ViewOpenParameters.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.UserSettings.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Utility-1.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Utility.FormOpenParameters.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Utility.OpenParameters.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.Utility.WindowOptions.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.WebApi.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.WebApiOffline.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.WebApiOnline.html delete mode 100644 docs/interfaces/node_modules__types_xrm.Xrm.XrmStatic.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.App.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Async.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Attributes.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Collection.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Controls.Grid.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Controls.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Device.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Events.Attribute.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Events.GridControl.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Events.KbSearchControl.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Events.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Metadata.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Navigation.NavigationOptions.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Navigation.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Page.data.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Page.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Page.ui.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.ProcessFlow.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Url.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.Utility.html delete mode 100644 docs/modules/node_modules__types_xrm.Xrm.html delete mode 100644 docs/modules/node_modules__types_xrm.XrmEnum.html delete mode 100644 docs/modules/node_modules__types_xrm.html delete mode 100644 docs/modules/src_XrmEx.XrmEx.Class.html delete mode 100644 docs/modules/src_XrmEx.XrmEx.html delete mode 100644 docs/modules/src_XrmEx.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Attributes.AttributeFormat.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Attributes.AttributeType.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Attributes.DateAttributeFormat.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Attributes.IntegerAttributeFormat.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Attributes.OptionSetAttributeFormat.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Attributes.RequirementLevel.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Attributes.StringAttributeFormat.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Client.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.ClientState.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Collection.IterativeDelegate.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Collection.MatchingDelegate.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Collection.StringIndexableItemCollection.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Controls.ControlQuickFormType.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Controls.ControlType.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Controls.NotificationLevel.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Device.PickFileTypes.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.DisplayState.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.EntitySaveMode.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.Attribute.ChangeEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.ContextSensitiveHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.DataLoadEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.GridControl.LoadEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.PostSearchEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.ResultOpenedEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.SelectionEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.LoadEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.LoadEventHandlerAsync.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.LookupTagClickHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.PostSaveEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.ProcessStatusChangeHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.SaveEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.SaveEventHandlerAsync.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.StageChangeEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Events.StageSelectedEventHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.FormNotificationLevel.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.AttributeFormat.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.AttributeType.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.ContextSensitiveHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.ControlQuickFormType.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.ControlType.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.DateAttributeFormat.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.IntegerAttributeFormat.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.NotificationLevel.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.OptionSetAttributeFormat.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.ProcessStatus.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.ProcessStatusChangeHandler.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.RequirementLevel.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.SaveMode.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.StageChangeDirection.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.StageStatus.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.StringAttributeFormat.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.SubmitMode.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.data.GetProcessInstancesDelegate.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.data.ProcessCallbackDelegate.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.data.ProcessSetStatusDelegate.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.data.SetProcessInstanceDelegate.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.ui.DisplayState.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Page.ui.FormNotificationLevel.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.ProcessFlow.GetProcessInstancesDelegate.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessCallbackDelegate.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessSetStatusDelegate.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessStatus.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.ProcessFlow.SetProcessInstanceDelegate.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.ProcessFlow.StageChangeDirection.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.ProcessFlow.StageStatus.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.SubmitMode.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Theme.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Url.CmdBarDisplay.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Url.NavBarDisplay.html delete mode 100644 docs/types/node_modules__types_xrm.Xrm.Url.ReportAction.html delete mode 100644 docs/variables/node_modules__types_xrm.Window-1.html delete mode 100644 docs/variables/node_modules__types_xrm.Xrm-1.html diff --git a/.gitignore b/.gitignore index 50c83ea..d8275e0 100644 --- a/.gitignore +++ b/.gitignore @@ -24,4 +24,5 @@ service-account-credentials.json **/pubsub-debug.log **/tsconfig-compile.json yarn.lock -**/.DS_Store \ No newline at end of file +**/.DS_Store +docs diff --git a/README.md b/README.md index 9eb99d6..c14c22a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ ![NPM](https://img.shields.io/npm/l/xrm-ex) ![NPM](https://img.shields.io/npm/v/xrm-ex) +![NPM](https://img.shields.io/npm/d18m/xrm-ex) ![GitHub Workflow Status](https://github.com/AhashSritharan/Xrm-Ex/actions/workflows/XrmEx.yml/badge.svg?branch%253Dmain) [![NPM](https://nodei.co/npm/xrm-ex.png)](https://nodei.co/npm/xrm-ex/) @@ -377,15 +378,10 @@ console.log(response); ```js let response2 = await XrmEx.executeAction( - "theia_TestActionContact", - [ - { Name: "Amount", Type: "Integer", Value: 5 }, - { - Name: "Account", - Type: "EntityReference", - Value: fields.Customer.Value[0], - }, - ], + "theia_TestActionContact",{ + Amount: 5, + Account: fields.Customer.Value[0] + }, XrmEx.Form.entityReference ); console.log(response2); diff --git a/READMEDOCS.md b/READMEDOCS.md index dbaaec5..8fb40aa 100644 --- a/READMEDOCS.md +++ b/READMEDOCS.md @@ -341,15 +341,10 @@ console.log(response); ```js let response2 = await XrmEx.executeAction( - "theia_TestActionContact", - [ - { Name: "Amount", Type: "Integer", Value: 5 }, - { - Name: "Account", - Type: "EntityReference", - Value: fields.Customer.Value[0], - }, - ], + "theia_TestActionContact",{ + Amount: 5, + Account: fields.Customer.Value[0] + }, XrmEx.Form.entityReference ); console.log(response2); diff --git a/build/README.md b/build/README.md index 9eb99d6..c14c22a 100644 --- a/build/README.md +++ b/build/README.md @@ -1,5 +1,6 @@ ![NPM](https://img.shields.io/npm/l/xrm-ex) ![NPM](https://img.shields.io/npm/v/xrm-ex) +![NPM](https://img.shields.io/npm/d18m/xrm-ex) ![GitHub Workflow Status](https://github.com/AhashSritharan/Xrm-Ex/actions/workflows/XrmEx.yml/badge.svg?branch%253Dmain) [![NPM](https://nodei.co/npm/xrm-ex.png)](https://nodei.co/npm/xrm-ex/) @@ -377,15 +378,10 @@ console.log(response); ```js let response2 = await XrmEx.executeAction( - "theia_TestActionContact", - [ - { Name: "Amount", Type: "Integer", Value: 5 }, - { - Name: "Account", - Type: "EntityReference", - Value: fields.Customer.Value[0], - }, - ], + "theia_TestActionContact",{ + Amount: 5, + Account: fields.Customer.Value[0] + }, XrmEx.Form.entityReference ); console.log(response2); diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css deleted file mode 100644 index 73747f3..0000000 --- a/docs/assets/highlight.css +++ /dev/null @@ -1,134 +0,0 @@ -:root { - --light-hl-0: #795E26; - --dark-hl-0: #DCDCAA; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #A31515; - --dark-hl-2: #CE9178; - --light-hl-3: #008000; - --dark-hl-3: #6A9955; - --light-hl-4: #800000; - --dark-hl-4: #808080; - --light-hl-5: #800000; - --dark-hl-5: #569CD6; - --light-hl-6: #E50000; - --dark-hl-6: #9CDCFE; - --light-hl-7: #0000FF; - --dark-hl-7: #569CD6; - --light-hl-8: #001080; - --dark-hl-8: #9CDCFE; - --light-hl-9: #267F99; - --dark-hl-9: #4EC9B0; - --light-hl-10: #098658; - --dark-hl-10: #B5CEA8; - --light-hl-11: #AF00DB; - --dark-hl-11: #C586C0; - --light-hl-12: #000000FF; - --dark-hl-12: #D4D4D4; - --light-hl-13: #EE0000; - --dark-hl-13: #D7BA7D; - --light-hl-14: #000000; - --dark-hl-14: #C8C8C8; - --light-hl-15: #CD3131; - --dark-hl-15: #F44747; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --hl-14: var(--light-hl-14); - --hl-15: var(--light-hl-15); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --hl-14: var(--dark-hl-14); - --hl-15: var(--dark-hl-15); - --code-background: var(--dark-code-background); -} } - -:root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --hl-14: var(--light-hl-14); - --hl-15: var(--light-hl-15); - --code-background: var(--light-code-background); -} - -:root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --hl-14: var(--dark-hl-14); - --hl-15: var(--dark-hl-15); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.hl-2 { color: var(--hl-2); } -.hl-3 { color: var(--hl-3); } -.hl-4 { color: var(--hl-4); } -.hl-5 { color: var(--hl-5); } -.hl-6 { color: var(--hl-6); } -.hl-7 { color: var(--hl-7); } -.hl-8 { color: var(--hl-8); } -.hl-9 { color: var(--hl-9); } -.hl-10 { color: var(--hl-10); } -.hl-11 { color: var(--hl-11); } -.hl-12 { color: var(--hl-12); } -.hl-13 { color: var(--hl-13); } -.hl-14 { color: var(--hl-14); } -.hl-15 { color: var(--hl-15); } -pre, code { background: var(--code-background); } diff --git a/docs/assets/main.js b/docs/assets/main.js deleted file mode 100644 index 4c8fa61..0000000 --- a/docs/assets/main.js +++ /dev/null @@ -1,58 +0,0 @@ -"use strict"; -"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=n}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); -/*! Bundled license information: - -lunr/lunr.js: - (** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - *) - (*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - *) - (*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - *) -*/ diff --git a/docs/assets/search.js b/docs/assets/search.js deleted file mode 100644 index 52e45cc..0000000 --- a/docs/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":2,\"name\":\"src/XrmEx\",\"url\":\"modules/src_XrmEx.html\",\"classes\":\"\"},{\"kind\":4,\"name\":\"XrmEx\",\"url\":\"modules/src_XrmEx.XrmEx.html\",\"classes\":\"\",\"parent\":\"src/XrmEx\"},{\"kind\":64,\"name\":\"throwError\",\"url\":\"functions/src_XrmEx.XrmEx.throwError.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":64,\"name\":\"getFunctionName\",\"url\":\"functions/src_XrmEx.XrmEx.getFunctionName.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":64,\"name\":\"addGlobalNotification\",\"url\":\"functions/src_XrmEx.XrmEx.addGlobalNotification.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":64,\"name\":\"removeGlobalNotification\",\"url\":\"functions/src_XrmEx.XrmEx.removeGlobalNotification.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":64,\"name\":\"getEnvironmentVariableValue\",\"url\":\"functions/src_XrmEx.XrmEx.getEnvironmentVariableValue.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":64,\"name\":\"checkRequestParameterType\",\"url\":\"functions/src_XrmEx.XrmEx.checkRequestParameterType.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":64,\"name\":\"executeAction\",\"url\":\"functions/src_XrmEx.XrmEx.executeAction.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":64,\"name\":\"executeFunction\",\"url\":\"functions/src_XrmEx.XrmEx.executeFunction.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":64,\"name\":\"normalizeGuid\",\"url\":\"functions/src_XrmEx.XrmEx.normalizeGuid.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":64,\"name\":\"asPromise\",\"url\":\"functions/src_XrmEx.XrmEx.asPromise.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":64,\"name\":\"openAlertDialog\",\"url\":\"functions/src_XrmEx.XrmEx.openAlertDialog.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":128,\"name\":\"Process\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":262144,\"name\":\"data\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#data\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":262144,\"name\":\"ui\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#ui\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"addOnPreProcessStatusChange\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#addOnPreProcessStatusChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"addOnPreStageChange\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#addOnPreStageChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"addOnProcessStatusChange\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#addOnProcessStatusChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"addOnStageChange\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#addOnStageChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"addOnStageSelected\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#addOnStageSelected\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"removeOnPreProcessStatusChange\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#removeOnPreProcessStatusChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"removeOnPreStageChange\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#removeOnPreStageChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"removeOnProcessStatusChange\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#removeOnProcessStatusChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"removeOnStageChange\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#removeOnStageChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"removeOnStageSelected\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#removeOnStageSelected\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"getEnabledProcesses\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#getEnabledProcesses\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"getProcessInstances\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#getProcessInstances\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"moveNext\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#moveNext\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"movePrevious\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#movePrevious\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"setActiveProcess\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#setActiveProcess\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"setActiveProcessInstance\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#setActiveProcessInstance\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"setActiveStage\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#setActiveStage\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":2048,\"name\":\"setStatus\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#setStatus\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Process.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Process\"},{\"kind\":128,\"name\":\"Fields\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":2048,\"name\":\"addOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#addOnChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"fireOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#fireOnChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"removeOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#removeOnChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"setRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#setRequiredLevel\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"setSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#setSubmitMode\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#setValue\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"setIsValid\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#setIsValid\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"setRequired\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#setRequired\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"setDisabled\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#setDisabled\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#setVisible\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"setNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#setNotification\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"addNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#addNotification\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":2048,\"name\":\"removeNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#removeNotification\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Fields.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Fields\"},{\"kind\":128,\"name\":\"Form\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":1024,\"name\":\"_formContext\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#_formContext\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":1024,\"name\":\"_executionContext\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#_executionContext\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":262144,\"name\":\"formContext\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#formContext\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":262144,\"name\":\"executionContext\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#executionContext\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":262144,\"name\":\"entityReference\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#entityReference\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":262144,\"name\":\"IsCreate\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#IsCreate\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":262144,\"name\":\"IsUpdate\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#IsUpdate\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":262144,\"name\":\"IsNotCreate\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#IsNotCreate\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":262144,\"name\":\"IsNotUpdate\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#IsNotUpdate\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":2048,\"name\":\"addFormNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#addFormNotification\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":2048,\"name\":\"removeFormNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#removeFormNotification\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":2048,\"name\":\"addOnSave\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#addOnSave\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":2048,\"name\":\"addOnPostSave\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#addOnPostSave\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":2048,\"name\":\"addOnLoad\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#addOnLoad\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":2048,\"name\":\"addOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#addOnChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Form.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Form\"},{\"kind\":4,\"name\":\"Class\",\"url\":\"modules/src_XrmEx.XrmEx.Class.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx\"},{\"kind\":128,\"name\":\"Field\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":1024,\"name\":\"allFields\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#allFields\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#Name\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":1024,\"name\":\"_attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#_attribute\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#setValue\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"getAttributeType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#getAttributeType\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"getFormat\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#getFormat\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"getIsDirty\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#getIsDirty\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#getName\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#getParent\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"getRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#getRequiredLevel\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"getSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#getSubmitMode\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"getUserPrivilege\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#getUserPrivilege\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"removeOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#removeOnChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"setSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#setSubmitMode\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"getValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#getValue\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"setIsValid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#setIsValid\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":262144,\"name\":\"Attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#Attribute\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":262144,\"name\":\"controls\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#controls\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":262144,\"name\":\"Value\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#Value\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"setNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#setNotification\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#setVisible\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"setDisabled\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#setDisabled\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"setRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#setRequiredLevel\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"setRequired\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#setRequired\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"fireOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#fireOnChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"addOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#addOnChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"addNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#addNotification\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":2048,\"name\":\"removeNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Field.html#removeNotification\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Field\"},{\"kind\":128,\"name\":\"TextField\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":1024,\"name\":\"allFields\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#allFields\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":1024,\"name\":\"_attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#_attribute\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"getMaxLength\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#getMaxLength\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"getFormat\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#getFormat\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":262144,\"name\":\"Attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#Attribute\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":262144,\"name\":\"controls\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#controls\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":262144,\"name\":\"Value\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#Value\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#Name\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#setValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"getAttributeType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#getAttributeType\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"getIsDirty\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#getIsDirty\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#getName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#getParent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"getRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#getRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"getSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#getSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"getUserPrivilege\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#getUserPrivilege\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"removeOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#removeOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"setSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#setSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"getValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#getValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"setIsValid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#setIsValid\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"setNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#setNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#setVisible\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"setDisabled\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#setDisabled\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"setRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#setRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"setRequired\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#setRequired\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"fireOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#fireOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"addOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#addOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"addNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#addNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":2048,\"name\":\"removeNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.TextField.html#removeNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.TextField\"},{\"kind\":128,\"name\":\"NumberField\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":1024,\"name\":\"allFields\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#allFields\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":1024,\"name\":\"_attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#_attribute\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getFormat\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getFormat\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getMax\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getMax\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getMin\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getMin\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getPrecision\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getPrecision\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"setPrecision\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#setPrecision\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":262144,\"name\":\"Attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#Attribute\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":262144,\"name\":\"controls\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#controls\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":262144,\"name\":\"Value\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#Value\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#Name\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#setValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getAttributeType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getAttributeType\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getIsDirty\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getIsDirty\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getParent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getUserPrivilege\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getUserPrivilege\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"removeOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#removeOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"setSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#setSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"getValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#getValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"setIsValid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#setIsValid\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"setNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#setNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#setVisible\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"setDisabled\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#setDisabled\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"setRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#setRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"setRequired\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#setRequired\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"fireOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#fireOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"addOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#addOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"addNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#addNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":2048,\"name\":\"removeNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.NumberField.html#removeNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.NumberField\"},{\"kind\":128,\"name\":\"DateField\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":1024,\"name\":\"allFields\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#allFields\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":1024,\"name\":\"_attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#_attribute\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"getFormat\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#getFormat\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":262144,\"name\":\"Attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#Attribute\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":262144,\"name\":\"controls\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#controls\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":262144,\"name\":\"Value\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#Value\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#Name\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#setValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"getAttributeType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#getAttributeType\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"getIsDirty\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#getIsDirty\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#getName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#getParent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"getRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#getRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"getSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#getSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"getUserPrivilege\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#getUserPrivilege\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"removeOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#removeOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"setSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#setSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"getValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#getValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"setIsValid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#setIsValid\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"setNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#setNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#setVisible\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"setDisabled\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#setDisabled\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"setRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#setRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"setRequired\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#setRequired\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"fireOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#fireOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"addOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#addOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"addNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#addNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":2048,\"name\":\"removeNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.DateField.html#removeNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.DateField\"},{\"kind\":128,\"name\":\"BooleanField\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":1024,\"name\":\"allFields\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#allFields\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":1024,\"name\":\"_attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#_attribute\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"getAttributeType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#getAttributeType\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"getInitialValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#getInitialValue\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":262144,\"name\":\"Attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#Attribute\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":262144,\"name\":\"controls\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#controls\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":262144,\"name\":\"Value\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#Value\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#Name\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#setValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"getFormat\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#getFormat\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"getIsDirty\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#getIsDirty\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#getName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#getParent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"getRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#getRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"getSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#getSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"getUserPrivilege\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#getUserPrivilege\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"removeOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#removeOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"setSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#setSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"getValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#getValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"setIsValid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#setIsValid\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"setNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#setNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#setVisible\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"setDisabled\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#setDisabled\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"setRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#setRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"setRequired\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#setRequired\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"fireOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#fireOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"addOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#addOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"addNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#addNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":2048,\"name\":\"removeNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.BooleanField.html#removeNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.BooleanField\"},{\"kind\":128,\"name\":\"MultiSelectOptionSetField\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":1024,\"name\":\"allFields\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#allFields\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":1024,\"name\":\"_attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#_attribute\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":1024,\"name\":\"Option\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#Option\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getFormat\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getFormat\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getOption\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getOption\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getOptions\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getOptions\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getSelectedOption\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getSelectedOption\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getText\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getText\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getInitialValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getInitialValue\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":262144,\"name\":\"Attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#Attribute\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":262144,\"name\":\"controls\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#controls\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":262144,\"name\":\"Value\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#Value\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#Name\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#setValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getAttributeType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getAttributeType\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getIsDirty\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getIsDirty\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getParent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getUserPrivilege\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getUserPrivilege\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"removeOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#removeOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"setSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#setSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"getValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#getValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"setIsValid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#setIsValid\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"setNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#setNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#setVisible\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"setDisabled\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#setDisabled\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"setRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#setRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"setRequired\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#setRequired\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"fireOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#fireOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"addOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#addOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"addNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#addNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":2048,\"name\":\"removeNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html#removeNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.MultiSelectOptionSetField\"},{\"kind\":128,\"name\":\"LookupField\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":1024,\"name\":\"allFields\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#allFields\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":1024,\"name\":\"_attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#_attribute\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":1024,\"name\":\"_customFilters\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#_customFilters\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"getIsPartyList\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#getIsPartyList\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":262144,\"name\":\"Attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#Attribute\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":262144,\"name\":\"controls\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#controls\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":262144,\"name\":\"Id\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#Id\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":262144,\"name\":\"EntityType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#EntityType\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":262144,\"name\":\"FormattedValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#FormattedValue\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":262144,\"name\":\"Value\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#Value\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"setLookupValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#setLookupValue\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"setLookupFromRetrieve\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#setLookupFromRetrieve\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"retrieve\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#retrieve\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"addPreFilterToLookup\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#addPreFilterToLookup\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"addPreFilterToLookupAdvanced\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#addPreFilterToLookupAdvanced\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"clearPreFilterFromLookup\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#clearPreFilterFromLookup\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#Name\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#setValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"getAttributeType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#getAttributeType\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"getFormat\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#getFormat\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"getIsDirty\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#getIsDirty\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#getName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#getParent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"getRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#getRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"getSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#getSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"getUserPrivilege\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#getUserPrivilege\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"removeOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#removeOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"setSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#setSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"getValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#getValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"setIsValid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#setIsValid\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"setNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#setNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#setVisible\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"setDisabled\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#setDisabled\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"setRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#setRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"setRequired\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#setRequired\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"fireOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#fireOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"addOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#addOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"addNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#addNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":2048,\"name\":\"removeNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.LookupField.html#removeNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.LookupField\"},{\"kind\":128,\"name\":\"OptionsetField\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":1024,\"name\":\"allFields\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#allFields\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":1024,\"name\":\"_attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#_attribute\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":1024,\"name\":\"_control\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#_control\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":1024,\"name\":\"Option\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#Option\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getFormat\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getFormat\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getOption\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getOption\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getOptions\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getOptions\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getSelectedOption\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getSelectedOption\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getText\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getText\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getInitialValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getInitialValue\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":262144,\"name\":\"Attribute\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#Attribute\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":262144,\"name\":\"controls\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#controls\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":262144,\"name\":\"control\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#control\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":262144,\"name\":\"Value\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#Value\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"addOption\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#addOption\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"removeOption\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#removeOption\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"clearOptions\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#clearOptions\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#Name\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"setValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#setValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getAttributeType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getAttributeType\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getIsDirty\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getIsDirty\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getName\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getParent\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getUserPrivilege\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getUserPrivilege\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"removeOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#removeOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"setSubmitMode\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#setSubmitMode\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"getValue\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#getValue\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"setIsValid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#setIsValid\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"setNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#setNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#setVisible\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"setDisabled\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#setDisabled\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"setRequiredLevel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#setRequiredLevel\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"setRequired\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#setRequired\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"fireOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#fireOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"addOnChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#addOnChange\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"addNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#addNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":2048,\"name\":\"removeNotification\",\"url\":\"classes/src_XrmEx.XrmEx.Class.OptionsetField.html#removeNotification\",\"classes\":\"tsd-is-inherited\",\"parent\":\"src/XrmEx.XrmEx.Class.OptionsetField\"},{\"kind\":128,\"name\":\"Section\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#Name\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":1024,\"name\":\"_section\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#_section\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":1024,\"name\":\"parentTab\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#parentTab\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":262144,\"name\":\"Section\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#Section\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#getName\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#getParent\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":1024,\"name\":\"controls\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#controls\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#setVisible\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":2048,\"name\":\"getVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#getVisible\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":2048,\"name\":\"getLabel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#getLabel\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":2048,\"name\":\"setLabel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Section.html#setLabel\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Section\"},{\"kind\":128,\"name\":\"Tab\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#Name\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":1024,\"name\":\"_tab\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#_tab\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":1024,\"name\":\"Section\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#Section\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":1024,\"name\":\"sections\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#sections\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":262144,\"name\":\"Tab\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#Tab\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"addTabStateChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#addTabStateChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"getDisplayState\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#getDisplayState\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#getName\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#getParent\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"removeTabStateChange\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#removeTabStateChange\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"setDisplayState\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#setDisplayState\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#setVisible\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"getVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#getVisible\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"getLabel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#getLabel\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"setLabel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#setLabel\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":2048,\"name\":\"setFocus\",\"url\":\"classes/src_XrmEx.XrmEx.Class.Tab.html#setFocus\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.Tab\"},{\"kind\":128,\"name\":\"GridControl\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#constructor\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#Name\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":1024,\"name\":\"_gridControl\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#_gridControl\",\"classes\":\"tsd-is-protected\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":262144,\"name\":\"GridControl\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#GridControl\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":262144,\"name\":\"Grid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#Grid\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"addOnLoad\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#addOnLoad\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getContextType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getContextType\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getEntityName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getEntityName\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getFetchXml\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getFetchXml\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getGrid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getGrid\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getRelationship\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getRelationship\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getUrl\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getUrl\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getViewSelector\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getViewSelector\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"openRelatedGrid\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#openRelatedGrid\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"refresh\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#refresh\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"refreshRibbon\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#refreshRibbon\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"removeOnLoad\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#removeOnLoad\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getControlType\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getControlType\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getName\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getName\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getParent\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getParent\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getLabel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getLabel\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"setLabel\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#setLabel\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"getVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#getVisible\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2048,\"name\":\"setVisible\",\"url\":\"classes/src_XrmEx.XrmEx.Class.GridControl.html#setVisible\",\"classes\":\"\",\"parent\":\"src/XrmEx.XrmEx.Class.GridControl\"},{\"kind\":2,\"name\":\"node_modules/@types/xrm\",\"url\":\"modules/node_modules__types_xrm.html\",\"classes\":\"\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,55.86]],[\"comment/0\",[]],[\"name/1\",[1,55.86]],[\"comment/1\",[]],[\"name/2\",[2,55.86]],[\"comment/2\",[]],[\"name/3\",[3,55.86]],[\"comment/3\",[]],[\"name/4\",[4,55.86]],[\"comment/4\",[]],[\"name/5\",[5,55.86]],[\"comment/5\",[]],[\"name/6\",[6,55.86]],[\"comment/6\",[]],[\"name/7\",[7,55.86]],[\"comment/7\",[]],[\"name/8\",[8,55.86]],[\"comment/8\",[]],[\"name/9\",[9,55.86]],[\"comment/9\",[]],[\"name/10\",[10,55.86]],[\"comment/10\",[]],[\"name/11\",[11,55.86]],[\"comment/11\",[]],[\"name/12\",[12,55.86]],[\"comment/12\",[]],[\"name/13\",[13,55.86]],[\"comment/13\",[]],[\"name/14\",[14,55.86]],[\"comment/14\",[]],[\"name/15\",[15,55.86]],[\"comment/15\",[]],[\"name/16\",[16,55.86]],[\"comment/16\",[]],[\"name/17\",[17,55.86]],[\"comment/17\",[]],[\"name/18\",[18,55.86]],[\"comment/18\",[]],[\"name/19\",[19,55.86]],[\"comment/19\",[]],[\"name/20\",[20,55.86]],[\"comment/20\",[]],[\"name/21\",[21,55.86]],[\"comment/21\",[]],[\"name/22\",[22,55.86]],[\"comment/22\",[]],[\"name/23\",[23,55.86]],[\"comment/23\",[]],[\"name/24\",[24,55.86]],[\"comment/24\",[]],[\"name/25\",[25,55.86]],[\"comment/25\",[]],[\"name/26\",[26,55.86]],[\"comment/26\",[]],[\"name/27\",[27,55.86]],[\"comment/27\",[]],[\"name/28\",[28,55.86]],[\"comment/28\",[]],[\"name/29\",[29,55.86]],[\"comment/29\",[]],[\"name/30\",[30,55.86]],[\"comment/30\",[]],[\"name/31\",[31,55.86]],[\"comment/31\",[]],[\"name/32\",[32,55.86]],[\"comment/32\",[]],[\"name/33\",[33,55.86]],[\"comment/33\",[]],[\"name/34\",[34,33.173]],[\"comment/34\",[]],[\"name/35\",[35,55.86]],[\"comment/35\",[]],[\"name/36\",[36,36.401]],[\"comment/36\",[]],[\"name/37\",[37,37.402]],[\"comment/37\",[]],[\"name/38\",[38,37.402]],[\"comment/38\",[]],[\"name/39\",[39,37.402]],[\"comment/39\",[]],[\"name/40\",[40,37.402]],[\"comment/40\",[]],[\"name/41\",[41,37.402]],[\"comment/41\",[]],[\"name/42\",[42,37.402]],[\"comment/42\",[]],[\"name/43\",[43,37.402]],[\"comment/43\",[]],[\"name/44\",[44,37.402]],[\"comment/44\",[]],[\"name/45\",[45,34.657]],[\"comment/45\",[]],[\"name/46\",[46,37.402]],[\"comment/46\",[]],[\"name/47\",[47,37.402]],[\"comment/47\",[]],[\"name/48\",[48,37.402]],[\"comment/48\",[]],[\"name/49\",[34,33.173]],[\"comment/49\",[]],[\"name/50\",[49,55.86]],[\"comment/50\",[]],[\"name/51\",[50,55.86]],[\"comment/51\",[]],[\"name/52\",[51,55.86]],[\"comment/52\",[]],[\"name/53\",[52,55.86]],[\"comment/53\",[]],[\"name/54\",[53,55.86]],[\"comment/54\",[]],[\"name/55\",[54,55.86]],[\"comment/55\",[]],[\"name/56\",[55,55.86]],[\"comment/56\",[]],[\"name/57\",[56,55.86]],[\"comment/57\",[]],[\"name/58\",[57,55.86]],[\"comment/58\",[]],[\"name/59\",[58,55.86]],[\"comment/59\",[]],[\"name/60\",[59,55.86]],[\"comment/60\",[]],[\"name/61\",[60,55.86]],[\"comment/61\",[]],[\"name/62\",[61,55.86]],[\"comment/62\",[]],[\"name/63\",[62,55.86]],[\"comment/63\",[]],[\"name/64\",[63,50.752]],[\"comment/64\",[]],[\"name/65\",[36,36.401]],[\"comment/65\",[]],[\"name/66\",[34,33.173]],[\"comment/66\",[]],[\"name/67\",[64,55.86]],[\"comment/67\",[]],[\"name/68\",[65,55.86]],[\"comment/68\",[]],[\"name/69\",[66,38.514]],[\"comment/69\",[]],[\"name/70\",[34,33.173]],[\"comment/70\",[]],[\"name/71\",[67,35.491]],[\"comment/71\",[]],[\"name/72\",[68,38.514]],[\"comment/72\",[]],[\"name/73\",[41,37.402]],[\"comment/73\",[]],[\"name/74\",[69,38.514]],[\"comment/74\",[]],[\"name/75\",[70,38.514]],[\"comment/75\",[]],[\"name/76\",[71,38.514]],[\"comment/76\",[]],[\"name/77\",[72,35.491]],[\"comment/77\",[]],[\"name/78\",[73,35.491]],[\"comment/78\",[]],[\"name/79\",[74,38.514]],[\"comment/79\",[]],[\"name/80\",[75,38.514]],[\"comment/80\",[]],[\"name/81\",[76,38.514]],[\"comment/81\",[]],[\"name/82\",[38,37.402]],[\"comment/82\",[]],[\"name/83\",[40,37.402]],[\"comment/83\",[]],[\"name/84\",[77,38.514]],[\"comment/84\",[]],[\"name/85\",[42,37.402]],[\"comment/85\",[]],[\"name/86\",[78,38.514]],[\"comment/86\",[]],[\"name/87\",[79,37.402]],[\"comment/87\",[]],[\"name/88\",[80,38.514]],[\"comment/88\",[]],[\"name/89\",[46,37.402]],[\"comment/89\",[]],[\"name/90\",[45,34.657]],[\"comment/90\",[]],[\"name/91\",[44,37.402]],[\"comment/91\",[]],[\"name/92\",[39,37.402]],[\"comment/92\",[]],[\"name/93\",[43,37.402]],[\"comment/93\",[]],[\"name/94\",[37,37.402]],[\"comment/94\",[]],[\"name/95\",[36,36.401]],[\"comment/95\",[]],[\"name/96\",[47,37.402]],[\"comment/96\",[]],[\"name/97\",[48,37.402]],[\"comment/97\",[]],[\"name/98\",[81,55.86]],[\"comment/98\",[]],[\"name/99\",[66,38.514]],[\"comment/99\",[]],[\"name/100\",[34,33.173]],[\"comment/100\",[]],[\"name/101\",[68,38.514]],[\"comment/101\",[]],[\"name/102\",[82,55.86]],[\"comment/102\",[]],[\"name/103\",[70,38.514]],[\"comment/103\",[]],[\"name/104\",[78,38.514]],[\"comment/104\",[]],[\"name/105\",[79,37.402]],[\"comment/105\",[]],[\"name/106\",[80,38.514]],[\"comment/106\",[]],[\"name/107\",[67,35.491]],[\"comment/107\",[]],[\"name/108\",[41,37.402]],[\"comment/108\",[]],[\"name/109\",[69,38.514]],[\"comment/109\",[]],[\"name/110\",[71,38.514]],[\"comment/110\",[]],[\"name/111\",[72,35.491]],[\"comment/111\",[]],[\"name/112\",[73,35.491]],[\"comment/112\",[]],[\"name/113\",[74,38.514]],[\"comment/113\",[]],[\"name/114\",[75,38.514]],[\"comment/114\",[]],[\"name/115\",[76,38.514]],[\"comment/115\",[]],[\"name/116\",[38,37.402]],[\"comment/116\",[]],[\"name/117\",[40,37.402]],[\"comment/117\",[]],[\"name/118\",[77,38.514]],[\"comment/118\",[]],[\"name/119\",[42,37.402]],[\"comment/119\",[]],[\"name/120\",[46,37.402]],[\"comment/120\",[]],[\"name/121\",[45,34.657]],[\"comment/121\",[]],[\"name/122\",[44,37.402]],[\"comment/122\",[]],[\"name/123\",[39,37.402]],[\"comment/123\",[]],[\"name/124\",[43,37.402]],[\"comment/124\",[]],[\"name/125\",[37,37.402]],[\"comment/125\",[]],[\"name/126\",[36,36.401]],[\"comment/126\",[]],[\"name/127\",[47,37.402]],[\"comment/127\",[]],[\"name/128\",[48,37.402]],[\"comment/128\",[]],[\"name/129\",[83,55.86]],[\"comment/129\",[]],[\"name/130\",[66,38.514]],[\"comment/130\",[]],[\"name/131\",[34,33.173]],[\"comment/131\",[]],[\"name/132\",[68,38.514]],[\"comment/132\",[]],[\"name/133\",[70,38.514]],[\"comment/133\",[]],[\"name/134\",[84,55.86]],[\"comment/134\",[]],[\"name/135\",[85,55.86]],[\"comment/135\",[]],[\"name/136\",[86,55.86]],[\"comment/136\",[]],[\"name/137\",[87,55.86]],[\"comment/137\",[]],[\"name/138\",[78,38.514]],[\"comment/138\",[]],[\"name/139\",[79,37.402]],[\"comment/139\",[]],[\"name/140\",[80,38.514]],[\"comment/140\",[]],[\"name/141\",[67,35.491]],[\"comment/141\",[]],[\"name/142\",[41,37.402]],[\"comment/142\",[]],[\"name/143\",[69,38.514]],[\"comment/143\",[]],[\"name/144\",[71,38.514]],[\"comment/144\",[]],[\"name/145\",[72,35.491]],[\"comment/145\",[]],[\"name/146\",[73,35.491]],[\"comment/146\",[]],[\"name/147\",[74,38.514]],[\"comment/147\",[]],[\"name/148\",[75,38.514]],[\"comment/148\",[]],[\"name/149\",[76,38.514]],[\"comment/149\",[]],[\"name/150\",[38,37.402]],[\"comment/150\",[]],[\"name/151\",[40,37.402]],[\"comment/151\",[]],[\"name/152\",[77,38.514]],[\"comment/152\",[]],[\"name/153\",[42,37.402]],[\"comment/153\",[]],[\"name/154\",[46,37.402]],[\"comment/154\",[]],[\"name/155\",[45,34.657]],[\"comment/155\",[]],[\"name/156\",[44,37.402]],[\"comment/156\",[]],[\"name/157\",[39,37.402]],[\"comment/157\",[]],[\"name/158\",[43,37.402]],[\"comment/158\",[]],[\"name/159\",[37,37.402]],[\"comment/159\",[]],[\"name/160\",[36,36.401]],[\"comment/160\",[]],[\"name/161\",[47,37.402]],[\"comment/161\",[]],[\"name/162\",[48,37.402]],[\"comment/162\",[]],[\"name/163\",[88,55.86]],[\"comment/163\",[]],[\"name/164\",[66,38.514]],[\"comment/164\",[]],[\"name/165\",[34,33.173]],[\"comment/165\",[]],[\"name/166\",[68,38.514]],[\"comment/166\",[]],[\"name/167\",[70,38.514]],[\"comment/167\",[]],[\"name/168\",[78,38.514]],[\"comment/168\",[]],[\"name/169\",[79,37.402]],[\"comment/169\",[]],[\"name/170\",[80,38.514]],[\"comment/170\",[]],[\"name/171\",[67,35.491]],[\"comment/171\",[]],[\"name/172\",[41,37.402]],[\"comment/172\",[]],[\"name/173\",[69,38.514]],[\"comment/173\",[]],[\"name/174\",[71,38.514]],[\"comment/174\",[]],[\"name/175\",[72,35.491]],[\"comment/175\",[]],[\"name/176\",[73,35.491]],[\"comment/176\",[]],[\"name/177\",[74,38.514]],[\"comment/177\",[]],[\"name/178\",[75,38.514]],[\"comment/178\",[]],[\"name/179\",[76,38.514]],[\"comment/179\",[]],[\"name/180\",[38,37.402]],[\"comment/180\",[]],[\"name/181\",[40,37.402]],[\"comment/181\",[]],[\"name/182\",[77,38.514]],[\"comment/182\",[]],[\"name/183\",[42,37.402]],[\"comment/183\",[]],[\"name/184\",[46,37.402]],[\"comment/184\",[]],[\"name/185\",[45,34.657]],[\"comment/185\",[]],[\"name/186\",[44,37.402]],[\"comment/186\",[]],[\"name/187\",[39,37.402]],[\"comment/187\",[]],[\"name/188\",[43,37.402]],[\"comment/188\",[]],[\"name/189\",[37,37.402]],[\"comment/189\",[]],[\"name/190\",[36,36.401]],[\"comment/190\",[]],[\"name/191\",[47,37.402]],[\"comment/191\",[]],[\"name/192\",[48,37.402]],[\"comment/192\",[]],[\"name/193\",[89,55.86]],[\"comment/193\",[]],[\"name/194\",[66,38.514]],[\"comment/194\",[]],[\"name/195\",[34,33.173]],[\"comment/195\",[]],[\"name/196\",[68,38.514]],[\"comment/196\",[]],[\"name/197\",[69,38.514]],[\"comment/197\",[]],[\"name/198\",[90,47.387]],[\"comment/198\",[]],[\"name/199\",[78,38.514]],[\"comment/199\",[]],[\"name/200\",[79,37.402]],[\"comment/200\",[]],[\"name/201\",[80,38.514]],[\"comment/201\",[]],[\"name/202\",[67,35.491]],[\"comment/202\",[]],[\"name/203\",[41,37.402]],[\"comment/203\",[]],[\"name/204\",[70,38.514]],[\"comment/204\",[]],[\"name/205\",[71,38.514]],[\"comment/205\",[]],[\"name/206\",[72,35.491]],[\"comment/206\",[]],[\"name/207\",[73,35.491]],[\"comment/207\",[]],[\"name/208\",[74,38.514]],[\"comment/208\",[]],[\"name/209\",[75,38.514]],[\"comment/209\",[]],[\"name/210\",[76,38.514]],[\"comment/210\",[]],[\"name/211\",[38,37.402]],[\"comment/211\",[]],[\"name/212\",[40,37.402]],[\"comment/212\",[]],[\"name/213\",[77,38.514]],[\"comment/213\",[]],[\"name/214\",[42,37.402]],[\"comment/214\",[]],[\"name/215\",[46,37.402]],[\"comment/215\",[]],[\"name/216\",[45,34.657]],[\"comment/216\",[]],[\"name/217\",[44,37.402]],[\"comment/217\",[]],[\"name/218\",[39,37.402]],[\"comment/218\",[]],[\"name/219\",[43,37.402]],[\"comment/219\",[]],[\"name/220\",[37,37.402]],[\"comment/220\",[]],[\"name/221\",[36,36.401]],[\"comment/221\",[]],[\"name/222\",[47,37.402]],[\"comment/222\",[]],[\"name/223\",[48,37.402]],[\"comment/223\",[]],[\"name/224\",[91,55.86]],[\"comment/224\",[]],[\"name/225\",[66,38.514]],[\"comment/225\",[]],[\"name/226\",[34,33.173]],[\"comment/226\",[]],[\"name/227\",[68,38.514]],[\"comment/227\",[]],[\"name/228\",[92,50.752]],[\"comment/228\",[]],[\"name/229\",[70,38.514]],[\"comment/229\",[]],[\"name/230\",[93,50.752]],[\"comment/230\",[]],[\"name/231\",[94,50.752]],[\"comment/231\",[]],[\"name/232\",[95,50.752]],[\"comment/232\",[]],[\"name/233\",[96,50.752]],[\"comment/233\",[]],[\"name/234\",[90,47.387]],[\"comment/234\",[]],[\"name/235\",[78,38.514]],[\"comment/235\",[]],[\"name/236\",[79,37.402]],[\"comment/236\",[]],[\"name/237\",[80,38.514]],[\"comment/237\",[]],[\"name/238\",[67,35.491]],[\"comment/238\",[]],[\"name/239\",[41,37.402]],[\"comment/239\",[]],[\"name/240\",[69,38.514]],[\"comment/240\",[]],[\"name/241\",[71,38.514]],[\"comment/241\",[]],[\"name/242\",[72,35.491]],[\"comment/242\",[]],[\"name/243\",[73,35.491]],[\"comment/243\",[]],[\"name/244\",[74,38.514]],[\"comment/244\",[]],[\"name/245\",[75,38.514]],[\"comment/245\",[]],[\"name/246\",[76,38.514]],[\"comment/246\",[]],[\"name/247\",[38,37.402]],[\"comment/247\",[]],[\"name/248\",[40,37.402]],[\"comment/248\",[]],[\"name/249\",[77,38.514]],[\"comment/249\",[]],[\"name/250\",[42,37.402]],[\"comment/250\",[]],[\"name/251\",[46,37.402]],[\"comment/251\",[]],[\"name/252\",[45,34.657]],[\"comment/252\",[]],[\"name/253\",[44,37.402]],[\"comment/253\",[]],[\"name/254\",[39,37.402]],[\"comment/254\",[]],[\"name/255\",[43,37.402]],[\"comment/255\",[]],[\"name/256\",[37,37.402]],[\"comment/256\",[]],[\"name/257\",[36,36.401]],[\"comment/257\",[]],[\"name/258\",[47,37.402]],[\"comment/258\",[]],[\"name/259\",[48,37.402]],[\"comment/259\",[]],[\"name/260\",[97,55.86]],[\"comment/260\",[]],[\"name/261\",[66,38.514]],[\"comment/261\",[]],[\"name/262\",[34,33.173]],[\"comment/262\",[]],[\"name/263\",[68,38.514]],[\"comment/263\",[]],[\"name/264\",[98,55.86]],[\"comment/264\",[]],[\"name/265\",[99,55.86]],[\"comment/265\",[]],[\"name/266\",[78,38.514]],[\"comment/266\",[]],[\"name/267\",[79,37.402]],[\"comment/267\",[]],[\"name/268\",[100,55.86]],[\"comment/268\",[]],[\"name/269\",[101,55.86]],[\"comment/269\",[]],[\"name/270\",[102,55.86]],[\"comment/270\",[]],[\"name/271\",[80,38.514]],[\"comment/271\",[]],[\"name/272\",[103,55.86]],[\"comment/272\",[]],[\"name/273\",[104,55.86]],[\"comment/273\",[]],[\"name/274\",[105,55.86]],[\"comment/274\",[]],[\"name/275\",[106,55.86]],[\"comment/275\",[]],[\"name/276\",[107,55.86]],[\"comment/276\",[]],[\"name/277\",[108,55.86]],[\"comment/277\",[]],[\"name/278\",[67,35.491]],[\"comment/278\",[]],[\"name/279\",[41,37.402]],[\"comment/279\",[]],[\"name/280\",[69,38.514]],[\"comment/280\",[]],[\"name/281\",[70,38.514]],[\"comment/281\",[]],[\"name/282\",[71,38.514]],[\"comment/282\",[]],[\"name/283\",[72,35.491]],[\"comment/283\",[]],[\"name/284\",[73,35.491]],[\"comment/284\",[]],[\"name/285\",[74,38.514]],[\"comment/285\",[]],[\"name/286\",[75,38.514]],[\"comment/286\",[]],[\"name/287\",[76,38.514]],[\"comment/287\",[]],[\"name/288\",[38,37.402]],[\"comment/288\",[]],[\"name/289\",[40,37.402]],[\"comment/289\",[]],[\"name/290\",[77,38.514]],[\"comment/290\",[]],[\"name/291\",[42,37.402]],[\"comment/291\",[]],[\"name/292\",[46,37.402]],[\"comment/292\",[]],[\"name/293\",[45,34.657]],[\"comment/293\",[]],[\"name/294\",[44,37.402]],[\"comment/294\",[]],[\"name/295\",[39,37.402]],[\"comment/295\",[]],[\"name/296\",[43,37.402]],[\"comment/296\",[]],[\"name/297\",[37,37.402]],[\"comment/297\",[]],[\"name/298\",[36,36.401]],[\"comment/298\",[]],[\"name/299\",[47,37.402]],[\"comment/299\",[]],[\"name/300\",[48,37.402]],[\"comment/300\",[]],[\"name/301\",[109,55.86]],[\"comment/301\",[]],[\"name/302\",[66,38.514]],[\"comment/302\",[]],[\"name/303\",[34,33.173]],[\"comment/303\",[]],[\"name/304\",[68,38.514]],[\"comment/304\",[]],[\"name/305\",[110,55.86]],[\"comment/305\",[]],[\"name/306\",[92,50.752]],[\"comment/306\",[]],[\"name/307\",[70,38.514]],[\"comment/307\",[]],[\"name/308\",[93,50.752]],[\"comment/308\",[]],[\"name/309\",[94,50.752]],[\"comment/309\",[]],[\"name/310\",[95,50.752]],[\"comment/310\",[]],[\"name/311\",[96,50.752]],[\"comment/311\",[]],[\"name/312\",[90,47.387]],[\"comment/312\",[]],[\"name/313\",[78,38.514]],[\"comment/313\",[]],[\"name/314\",[79,37.402]],[\"comment/314\",[]],[\"name/315\",[111,55.86]],[\"comment/315\",[]],[\"name/316\",[80,38.514]],[\"comment/316\",[]],[\"name/317\",[112,55.86]],[\"comment/317\",[]],[\"name/318\",[113,55.86]],[\"comment/318\",[]],[\"name/319\",[114,55.86]],[\"comment/319\",[]],[\"name/320\",[67,35.491]],[\"comment/320\",[]],[\"name/321\",[41,37.402]],[\"comment/321\",[]],[\"name/322\",[69,38.514]],[\"comment/322\",[]],[\"name/323\",[71,38.514]],[\"comment/323\",[]],[\"name/324\",[72,35.491]],[\"comment/324\",[]],[\"name/325\",[73,35.491]],[\"comment/325\",[]],[\"name/326\",[74,38.514]],[\"comment/326\",[]],[\"name/327\",[75,38.514]],[\"comment/327\",[]],[\"name/328\",[76,38.514]],[\"comment/328\",[]],[\"name/329\",[38,37.402]],[\"comment/329\",[]],[\"name/330\",[40,37.402]],[\"comment/330\",[]],[\"name/331\",[77,38.514]],[\"comment/331\",[]],[\"name/332\",[42,37.402]],[\"comment/332\",[]],[\"name/333\",[46,37.402]],[\"comment/333\",[]],[\"name/334\",[45,34.657]],[\"comment/334\",[]],[\"name/335\",[44,37.402]],[\"comment/335\",[]],[\"name/336\",[39,37.402]],[\"comment/336\",[]],[\"name/337\",[43,37.402]],[\"comment/337\",[]],[\"name/338\",[37,37.402]],[\"comment/338\",[]],[\"name/339\",[36,36.401]],[\"comment/339\",[]],[\"name/340\",[47,37.402]],[\"comment/340\",[]],[\"name/341\",[48,37.402]],[\"comment/341\",[]],[\"name/342\",[115,47.387]],[\"comment/342\",[]],[\"name/343\",[34,33.173]],[\"comment/343\",[]],[\"name/344\",[67,35.491]],[\"comment/344\",[]],[\"name/345\",[116,55.86]],[\"comment/345\",[]],[\"name/346\",[117,55.86]],[\"comment/346\",[]],[\"name/347\",[115,47.387]],[\"comment/347\",[]],[\"name/348\",[72,35.491]],[\"comment/348\",[]],[\"name/349\",[73,35.491]],[\"comment/349\",[]],[\"name/350\",[79,37.402]],[\"comment/350\",[]],[\"name/351\",[45,34.657]],[\"comment/351\",[]],[\"name/352\",[118,47.387]],[\"comment/352\",[]],[\"name/353\",[119,47.387]],[\"comment/353\",[]],[\"name/354\",[120,47.387]],[\"comment/354\",[]],[\"name/355\",[121,50.752]],[\"comment/355\",[]],[\"name/356\",[34,33.173]],[\"comment/356\",[]],[\"name/357\",[67,35.491]],[\"comment/357\",[]],[\"name/358\",[122,55.86]],[\"comment/358\",[]],[\"name/359\",[115,47.387]],[\"comment/359\",[]],[\"name/360\",[123,55.86]],[\"comment/360\",[]],[\"name/361\",[121,50.752]],[\"comment/361\",[]],[\"name/362\",[124,55.86]],[\"comment/362\",[]],[\"name/363\",[125,55.86]],[\"comment/363\",[]],[\"name/364\",[72,35.491]],[\"comment/364\",[]],[\"name/365\",[73,35.491]],[\"comment/365\",[]],[\"name/366\",[126,55.86]],[\"comment/366\",[]],[\"name/367\",[127,55.86]],[\"comment/367\",[]],[\"name/368\",[45,34.657]],[\"comment/368\",[]],[\"name/369\",[118,47.387]],[\"comment/369\",[]],[\"name/370\",[119,47.387]],[\"comment/370\",[]],[\"name/371\",[120,47.387]],[\"comment/371\",[]],[\"name/372\",[128,55.86]],[\"comment/372\",[]],[\"name/373\",[129,50.752]],[\"comment/373\",[]],[\"name/374\",[34,33.173]],[\"comment/374\",[]],[\"name/375\",[67,35.491]],[\"comment/375\",[]],[\"name/376\",[130,55.86]],[\"comment/376\",[]],[\"name/377\",[129,50.752]],[\"comment/377\",[]],[\"name/378\",[131,55.86]],[\"comment/378\",[]],[\"name/379\",[63,50.752]],[\"comment/379\",[]],[\"name/380\",[132,55.86]],[\"comment/380\",[]],[\"name/381\",[133,55.86]],[\"comment/381\",[]],[\"name/382\",[134,55.86]],[\"comment/382\",[]],[\"name/383\",[135,55.86]],[\"comment/383\",[]],[\"name/384\",[136,55.86]],[\"comment/384\",[]],[\"name/385\",[137,55.86]],[\"comment/385\",[]],[\"name/386\",[138,55.86]],[\"comment/386\",[]],[\"name/387\",[139,55.86]],[\"comment/387\",[]],[\"name/388\",[140,55.86]],[\"comment/388\",[]],[\"name/389\",[141,55.86]],[\"comment/389\",[]],[\"name/390\",[142,55.86]],[\"comment/390\",[]],[\"name/391\",[143,55.86]],[\"comment/391\",[]],[\"name/392\",[72,35.491]],[\"comment/392\",[]],[\"name/393\",[73,35.491]],[\"comment/393\",[]],[\"name/394\",[119,47.387]],[\"comment/394\",[]],[\"name/395\",[120,47.387]],[\"comment/395\",[]],[\"name/396\",[118,47.387]],[\"comment/396\",[]],[\"name/397\",[45,34.657]],[\"comment/397\",[]],[\"name/398\",[144,55.86]],[\"comment/398\",[]]],\"invertedIndex\":[[\"_attribute\",{\"_index\":68,\"name\":{\"72\":{},\"101\":{},\"132\":{},\"166\":{},\"196\":{},\"227\":{},\"263\":{},\"304\":{}},\"comment\":{}}],[\"_control\",{\"_index\":110,\"name\":{\"305\":{}},\"comment\":{}}],[\"_customfilters\",{\"_index\":98,\"name\":{\"264\":{}},\"comment\":{}}],[\"_executioncontext\",{\"_index\":51,\"name\":{\"52\":{}},\"comment\":{}}],[\"_formcontext\",{\"_index\":50,\"name\":{\"51\":{}},\"comment\":{}}],[\"_gridcontrol\",{\"_index\":130,\"name\":{\"376\":{}},\"comment\":{}}],[\"_section\",{\"_index\":116,\"name\":{\"345\":{}},\"comment\":{}}],[\"_tab\",{\"_index\":122,\"name\":{\"358\":{}},\"comment\":{}}],[\"addformnotification\",{\"_index\":59,\"name\":{\"60\":{}},\"comment\":{}}],[\"addglobalnotification\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"addnotification\",{\"_index\":47,\"name\":{\"47\":{},\"96\":{},\"127\":{},\"161\":{},\"191\":{},\"222\":{},\"258\":{},\"299\":{},\"340\":{}},\"comment\":{}}],[\"addonchange\",{\"_index\":36,\"name\":{\"36\":{},\"65\":{},\"95\":{},\"126\":{},\"160\":{},\"190\":{},\"221\":{},\"257\":{},\"298\":{},\"339\":{}},\"comment\":{}}],[\"addonload\",{\"_index\":63,\"name\":{\"64\":{},\"379\":{}},\"comment\":{}}],[\"addonpostsave\",{\"_index\":62,\"name\":{\"63\":{}},\"comment\":{}}],[\"addonpreprocessstatuschange\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"addonprestagechange\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"addonprocessstatuschange\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"addonsave\",{\"_index\":61,\"name\":{\"62\":{}},\"comment\":{}}],[\"addonstagechange\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"addonstageselected\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"addoption\",{\"_index\":112,\"name\":{\"317\":{}},\"comment\":{}}],[\"addprefiltertolookup\",{\"_index\":106,\"name\":{\"275\":{}},\"comment\":{}}],[\"addprefiltertolookupadvanced\",{\"_index\":107,\"name\":{\"276\":{}},\"comment\":{}}],[\"addtabstatechange\",{\"_index\":124,\"name\":{\"362\":{}},\"comment\":{}}],[\"allfields\",{\"_index\":66,\"name\":{\"69\":{},\"99\":{},\"130\":{},\"164\":{},\"194\":{},\"225\":{},\"261\":{},\"302\":{}},\"comment\":{}}],[\"aspromise\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"attribute\",{\"_index\":78,\"name\":{\"86\":{},\"104\":{},\"138\":{},\"168\":{},\"199\":{},\"235\":{},\"266\":{},\"313\":{}},\"comment\":{}}],[\"booleanfield\",{\"_index\":89,\"name\":{\"193\":{}},\"comment\":{}}],[\"checkrequestparametertype\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"class\",{\"_index\":64,\"name\":{\"67\":{}},\"comment\":{}}],[\"clearoptions\",{\"_index\":114,\"name\":{\"319\":{}},\"comment\":{}}],[\"clearprefilterfromlookup\",{\"_index\":108,\"name\":{\"277\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":34,\"name\":{\"34\":{},\"49\":{},\"66\":{},\"70\":{},\"100\":{},\"131\":{},\"165\":{},\"195\":{},\"226\":{},\"262\":{},\"303\":{},\"343\":{},\"356\":{},\"374\":{}},\"comment\":{}}],[\"control\",{\"_index\":111,\"name\":{\"315\":{}},\"comment\":{}}],[\"controls\",{\"_index\":79,\"name\":{\"87\":{},\"105\":{},\"139\":{},\"169\":{},\"200\":{},\"236\":{},\"267\":{},\"314\":{},\"350\":{}},\"comment\":{}}],[\"data\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"datefield\",{\"_index\":88,\"name\":{\"163\":{}},\"comment\":{}}],[\"entityreference\",{\"_index\":54,\"name\":{\"55\":{}},\"comment\":{}}],[\"entitytype\",{\"_index\":101,\"name\":{\"269\":{}},\"comment\":{}}],[\"executeaction\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"executefunction\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"executioncontext\",{\"_index\":53,\"name\":{\"54\":{}},\"comment\":{}}],[\"field\",{\"_index\":65,\"name\":{\"68\":{}},\"comment\":{}}],[\"fields\",{\"_index\":35,\"name\":{\"35\":{}},\"comment\":{}}],[\"fireonchange\",{\"_index\":37,\"name\":{\"37\":{},\"94\":{},\"125\":{},\"159\":{},\"189\":{},\"220\":{},\"256\":{},\"297\":{},\"338\":{}},\"comment\":{}}],[\"form\",{\"_index\":49,\"name\":{\"50\":{}},\"comment\":{}}],[\"formattedvalue\",{\"_index\":102,\"name\":{\"270\":{}},\"comment\":{}}],[\"formcontext\",{\"_index\":52,\"name\":{\"53\":{}},\"comment\":{}}],[\"getattributetype\",{\"_index\":69,\"name\":{\"74\":{},\"109\":{},\"143\":{},\"173\":{},\"197\":{},\"240\":{},\"280\":{},\"322\":{}},\"comment\":{}}],[\"getcontexttype\",{\"_index\":132,\"name\":{\"380\":{}},\"comment\":{}}],[\"getcontroltype\",{\"_index\":143,\"name\":{\"391\":{}},\"comment\":{}}],[\"getdisplaystate\",{\"_index\":125,\"name\":{\"363\":{}},\"comment\":{}}],[\"getenabledprocesses\",{\"_index\":26,\"name\":{\"26\":{}},\"comment\":{}}],[\"getentityname\",{\"_index\":133,\"name\":{\"381\":{}},\"comment\":{}}],[\"getenvironmentvariablevalue\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"getfetchxml\",{\"_index\":134,\"name\":{\"382\":{}},\"comment\":{}}],[\"getformat\",{\"_index\":70,\"name\":{\"75\":{},\"103\":{},\"133\":{},\"167\":{},\"204\":{},\"229\":{},\"281\":{},\"307\":{}},\"comment\":{}}],[\"getfunctionname\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"getgrid\",{\"_index\":135,\"name\":{\"383\":{}},\"comment\":{}}],[\"getinitialvalue\",{\"_index\":90,\"name\":{\"198\":{},\"234\":{},\"312\":{}},\"comment\":{}}],[\"getisdirty\",{\"_index\":71,\"name\":{\"76\":{},\"110\":{},\"144\":{},\"174\":{},\"205\":{},\"241\":{},\"282\":{},\"323\":{}},\"comment\":{}}],[\"getispartylist\",{\"_index\":99,\"name\":{\"265\":{}},\"comment\":{}}],[\"getlabel\",{\"_index\":119,\"name\":{\"353\":{},\"370\":{},\"394\":{}},\"comment\":{}}],[\"getmax\",{\"_index\":84,\"name\":{\"134\":{}},\"comment\":{}}],[\"getmaxlength\",{\"_index\":82,\"name\":{\"102\":{}},\"comment\":{}}],[\"getmin\",{\"_index\":85,\"name\":{\"135\":{}},\"comment\":{}}],[\"getname\",{\"_index\":72,\"name\":{\"77\":{},\"111\":{},\"145\":{},\"175\":{},\"206\":{},\"242\":{},\"283\":{},\"324\":{},\"348\":{},\"364\":{},\"392\":{}},\"comment\":{}}],[\"getoption\",{\"_index\":93,\"name\":{\"230\":{},\"308\":{}},\"comment\":{}}],[\"getoptions\",{\"_index\":94,\"name\":{\"231\":{},\"309\":{}},\"comment\":{}}],[\"getparent\",{\"_index\":73,\"name\":{\"78\":{},\"112\":{},\"146\":{},\"176\":{},\"207\":{},\"243\":{},\"284\":{},\"325\":{},\"349\":{},\"365\":{},\"393\":{}},\"comment\":{}}],[\"getprecision\",{\"_index\":86,\"name\":{\"136\":{}},\"comment\":{}}],[\"getprocessinstances\",{\"_index\":27,\"name\":{\"27\":{}},\"comment\":{}}],[\"getrelationship\",{\"_index\":136,\"name\":{\"384\":{}},\"comment\":{}}],[\"getrequiredlevel\",{\"_index\":74,\"name\":{\"79\":{},\"113\":{},\"147\":{},\"177\":{},\"208\":{},\"244\":{},\"285\":{},\"326\":{}},\"comment\":{}}],[\"getselectedoption\",{\"_index\":95,\"name\":{\"232\":{},\"310\":{}},\"comment\":{}}],[\"getsubmitmode\",{\"_index\":75,\"name\":{\"80\":{},\"114\":{},\"148\":{},\"178\":{},\"209\":{},\"245\":{},\"286\":{},\"327\":{}},\"comment\":{}}],[\"gettext\",{\"_index\":96,\"name\":{\"233\":{},\"311\":{}},\"comment\":{}}],[\"geturl\",{\"_index\":137,\"name\":{\"385\":{}},\"comment\":{}}],[\"getuserprivilege\",{\"_index\":76,\"name\":{\"81\":{},\"115\":{},\"149\":{},\"179\":{},\"210\":{},\"246\":{},\"287\":{},\"328\":{}},\"comment\":{}}],[\"getvalue\",{\"_index\":77,\"name\":{\"84\":{},\"118\":{},\"152\":{},\"182\":{},\"213\":{},\"249\":{},\"290\":{},\"331\":{}},\"comment\":{}}],[\"getviewselector\",{\"_index\":138,\"name\":{\"386\":{}},\"comment\":{}}],[\"getvisible\",{\"_index\":118,\"name\":{\"352\":{},\"369\":{},\"396\":{}},\"comment\":{}}],[\"grid\",{\"_index\":131,\"name\":{\"378\":{}},\"comment\":{}}],[\"gridcontrol\",{\"_index\":129,\"name\":{\"373\":{},\"377\":{}},\"comment\":{}}],[\"id\",{\"_index\":100,\"name\":{\"268\":{}},\"comment\":{}}],[\"iscreate\",{\"_index\":55,\"name\":{\"56\":{}},\"comment\":{}}],[\"isnotcreate\",{\"_index\":57,\"name\":{\"58\":{}},\"comment\":{}}],[\"isnotupdate\",{\"_index\":58,\"name\":{\"59\":{}},\"comment\":{}}],[\"isupdate\",{\"_index\":56,\"name\":{\"57\":{}},\"comment\":{}}],[\"lookupfield\",{\"_index\":97,\"name\":{\"260\":{}},\"comment\":{}}],[\"movenext\",{\"_index\":28,\"name\":{\"28\":{}},\"comment\":{}}],[\"moveprevious\",{\"_index\":29,\"name\":{\"29\":{}},\"comment\":{}}],[\"multiselectoptionsetfield\",{\"_index\":91,\"name\":{\"224\":{}},\"comment\":{}}],[\"name\",{\"_index\":67,\"name\":{\"71\":{},\"107\":{},\"141\":{},\"171\":{},\"202\":{},\"238\":{},\"278\":{},\"320\":{},\"344\":{},\"357\":{},\"375\":{}},\"comment\":{}}],[\"node_modules/@types/xrm\",{\"_index\":144,\"name\":{\"398\":{}},\"comment\":{}}],[\"normalizeguid\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"numberfield\",{\"_index\":83,\"name\":{\"129\":{}},\"comment\":{}}],[\"openalertdialog\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"openrelatedgrid\",{\"_index\":139,\"name\":{\"387\":{}},\"comment\":{}}],[\"option\",{\"_index\":92,\"name\":{\"228\":{},\"306\":{}},\"comment\":{}}],[\"optionsetfield\",{\"_index\":109,\"name\":{\"301\":{}},\"comment\":{}}],[\"parenttab\",{\"_index\":117,\"name\":{\"346\":{}},\"comment\":{}}],[\"process\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"refresh\",{\"_index\":140,\"name\":{\"388\":{}},\"comment\":{}}],[\"refreshribbon\",{\"_index\":141,\"name\":{\"389\":{}},\"comment\":{}}],[\"removeformnotification\",{\"_index\":60,\"name\":{\"61\":{}},\"comment\":{}}],[\"removeglobalnotification\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"removenotification\",{\"_index\":48,\"name\":{\"48\":{},\"97\":{},\"128\":{},\"162\":{},\"192\":{},\"223\":{},\"259\":{},\"300\":{},\"341\":{}},\"comment\":{}}],[\"removeonchange\",{\"_index\":38,\"name\":{\"38\":{},\"82\":{},\"116\":{},\"150\":{},\"180\":{},\"211\":{},\"247\":{},\"288\":{},\"329\":{}},\"comment\":{}}],[\"removeonload\",{\"_index\":142,\"name\":{\"390\":{}},\"comment\":{}}],[\"removeonpreprocessstatuschange\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"removeonprestagechange\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"removeonprocessstatuschange\",{\"_index\":23,\"name\":{\"23\":{}},\"comment\":{}}],[\"removeonstagechange\",{\"_index\":24,\"name\":{\"24\":{}},\"comment\":{}}],[\"removeonstageselected\",{\"_index\":25,\"name\":{\"25\":{}},\"comment\":{}}],[\"removeoption\",{\"_index\":113,\"name\":{\"318\":{}},\"comment\":{}}],[\"removetabstatechange\",{\"_index\":126,\"name\":{\"366\":{}},\"comment\":{}}],[\"retrieve\",{\"_index\":105,\"name\":{\"274\":{}},\"comment\":{}}],[\"section\",{\"_index\":115,\"name\":{\"342\":{},\"347\":{},\"359\":{}},\"comment\":{}}],[\"sections\",{\"_index\":123,\"name\":{\"360\":{}},\"comment\":{}}],[\"setactiveprocess\",{\"_index\":30,\"name\":{\"30\":{}},\"comment\":{}}],[\"setactiveprocessinstance\",{\"_index\":31,\"name\":{\"31\":{}},\"comment\":{}}],[\"setactivestage\",{\"_index\":32,\"name\":{\"32\":{}},\"comment\":{}}],[\"setdisabled\",{\"_index\":44,\"name\":{\"44\":{},\"91\":{},\"122\":{},\"156\":{},\"186\":{},\"217\":{},\"253\":{},\"294\":{},\"335\":{}},\"comment\":{}}],[\"setdisplaystate\",{\"_index\":127,\"name\":{\"367\":{}},\"comment\":{}}],[\"setfocus\",{\"_index\":128,\"name\":{\"372\":{}},\"comment\":{}}],[\"setisvalid\",{\"_index\":42,\"name\":{\"42\":{},\"85\":{},\"119\":{},\"153\":{},\"183\":{},\"214\":{},\"250\":{},\"291\":{},\"332\":{}},\"comment\":{}}],[\"setlabel\",{\"_index\":120,\"name\":{\"354\":{},\"371\":{},\"395\":{}},\"comment\":{}}],[\"setlookupfromretrieve\",{\"_index\":104,\"name\":{\"273\":{}},\"comment\":{}}],[\"setlookupvalue\",{\"_index\":103,\"name\":{\"272\":{}},\"comment\":{}}],[\"setnotification\",{\"_index\":46,\"name\":{\"46\":{},\"89\":{},\"120\":{},\"154\":{},\"184\":{},\"215\":{},\"251\":{},\"292\":{},\"333\":{}},\"comment\":{}}],[\"setprecision\",{\"_index\":87,\"name\":{\"137\":{}},\"comment\":{}}],[\"setrequired\",{\"_index\":43,\"name\":{\"43\":{},\"93\":{},\"124\":{},\"158\":{},\"188\":{},\"219\":{},\"255\":{},\"296\":{},\"337\":{}},\"comment\":{}}],[\"setrequiredlevel\",{\"_index\":39,\"name\":{\"39\":{},\"92\":{},\"123\":{},\"157\":{},\"187\":{},\"218\":{},\"254\":{},\"295\":{},\"336\":{}},\"comment\":{}}],[\"setstatus\",{\"_index\":33,\"name\":{\"33\":{}},\"comment\":{}}],[\"setsubmitmode\",{\"_index\":40,\"name\":{\"40\":{},\"83\":{},\"117\":{},\"151\":{},\"181\":{},\"212\":{},\"248\":{},\"289\":{},\"330\":{}},\"comment\":{}}],[\"setvalue\",{\"_index\":41,\"name\":{\"41\":{},\"73\":{},\"108\":{},\"142\":{},\"172\":{},\"203\":{},\"239\":{},\"279\":{},\"321\":{}},\"comment\":{}}],[\"setvisible\",{\"_index\":45,\"name\":{\"45\":{},\"90\":{},\"121\":{},\"155\":{},\"185\":{},\"216\":{},\"252\":{},\"293\":{},\"334\":{},\"351\":{},\"368\":{},\"397\":{}},\"comment\":{}}],[\"src/xrmex\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"tab\",{\"_index\":121,\"name\":{\"355\":{},\"361\":{}},\"comment\":{}}],[\"textfield\",{\"_index\":81,\"name\":{\"98\":{}},\"comment\":{}}],[\"throwerror\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"ui\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"value\",{\"_index\":80,\"name\":{\"88\":{},\"106\":{},\"140\":{},\"170\":{},\"201\":{},\"237\":{},\"271\":{},\"316\":{}},\"comment\":{}}],[\"xrmex\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css deleted file mode 100644 index 18b4f8f..0000000 --- a/docs/assets/style.css +++ /dev/null @@ -1,1367 +0,0 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: var(--light-color-ts-type-alias); - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - /* object literal not included as it is not used and will be removed in 0.25 */ - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - /* object literal not included as it is not used and will be removed in 0.25 */ - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } -} - -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} - -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} - -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} - -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 > a, -h2 > a, -h3 > a, -h4 > a, -h5 > a, -h6 > a { - text-decoration: none; - color: var(--color-text); -} - -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} - -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} - -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} - -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} - -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} - -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} - -.uppercase { - text-transform: uppercase; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1700px; - padding: 0 2rem; -} - -/* Footer */ -.tsd-generator { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; -} - -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} - -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} - -pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography h4, -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} - -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); -} -.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} - -.tsd-theme-toggle { - padding-top: 0.75rem; -} -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; -} - -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} - -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} - -.tsd-anchor { - position: relative; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} - -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.5rem); -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: inline-flex; - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-nested-navigation > li > a, -.tsd-nested-navigation > li > span { - width: calc(100% - 1.75rem - 0.5rem); -} - -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; -} - -.tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 4rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: block; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} - -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} - -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} - -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} - -.deprecated { - text-decoration: line-through; -} - -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} - -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-literal { - color: var(--color-ts-type-literal); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} - -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} - -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} - -*::-webkit-scrollbar { - width: 0.75rem; -} - -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} - -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} - -/* mobile */ -@media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } -} - -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } -} diff --git a/docs/classes/src_XrmEx.XrmEx.Class.BooleanField.html b/docs/classes/src_XrmEx.XrmEx.Class.BooleanField.html deleted file mode 100644 index 0caa024..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.BooleanField.html +++ /dev/null @@ -1,716 +0,0 @@ -BooleanField | xrm-ex
-
- -
-
-
-
- -

Class BooleanField

-
-

Interface for a Boolean attribute.

-
-
-
-

Hierarchy

-
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
- -
-
-

Properties

-
- -
Name: string
-
- -
-
- -
allFields: Field[] = []
-
-

Accessors

-
- -
-
- -
    -
  • get Value(): boolean
  • -
  • -

    Gets the value.

    -
    -

    Returns boolean

    The value.

    - -
  • -
  • set Value(value): void
  • -
  • -
    -

    Parameters

    -
      -
    • -
      value: boolean
    -

    Returns void

-
- -
-
-

Methods

-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns BooleanField

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns BooleanField

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: any
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Class.DateField.html b/docs/classes/src_XrmEx.XrmEx.Class.DateField.html deleted file mode 100644 index f08ec0a..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.DateField.html +++ /dev/null @@ -1,694 +0,0 @@ -DateField | xrm-ex
-
- -
-
-
-
- -

Class DateField

-
-

Interface for a Date attribute.

-
-
-

See

Attribute

-
-
-

Hierarchy

-
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
- -
-
-

Properties

-
- -
Name: string
-
- -
-
- -
allFields: Field[] = []
-
-

Accessors

-
- -
-
- -
    -
  • get Value(): Date
  • -
  • -

    Gets the value.

    -
    -

    Returns Date

    The value.

    - -
  • -
  • set Value(value): void
  • -
  • -
    -

    Parameters

    -
      -
    • -
      value: Date
    -

    Returns void

-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns DateField

    -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns DateField

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns DateField

    -
-
- -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns DateField

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the required level.

    -
    -
    -

    Parameters

    -
      -
    • -
      required: boolean
      -

      The requirement level, as either false for "none" or true for "required"

      -
      -
    -

    Returns DateField

    -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: any
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Class.Field.html b/docs/classes/src_XrmEx.XrmEx.Class.Field.html deleted file mode 100644 index d7e8b40..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.Field.html +++ /dev/null @@ -1,684 +0,0 @@ -Field | xrm-ex
-
- -
-
-
-
- -

Class Field

-
-

Used to execute methods related to a single Attribute

-
-
-
-

Hierarchy

-
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
- -
-
-

Properties

-
- -
Name: string
-
- -
_attribute?: Xrm.Attributes.Attribute<any>
-
- -
allFields: Field[] = []
-
-

Accessors

-
- -
-
- -
    -
  • get Value(): any
  • -
  • -

    Gets the value.

    -
    -

    Returns any

    The value.

    - -
  • -
  • set Value(value): void
  • -
  • -
    -

    Parameters

    -
      -
    • -
      value: any
    -

    Returns void

-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns Field

    -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns Field

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns Field

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns Field

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the required level.

    -
    -
    -

    Parameters

    -
      -
    • -
      required: boolean
      -

      The requirement level, as either false for "none" or true for "required"

      -
      -
    -

    Returns Field

    -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: any
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns Field

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Class.GridControl.html b/docs/classes/src_XrmEx.XrmEx.Class.GridControl.html deleted file mode 100644 index 01596f0..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.GridControl.html +++ /dev/null @@ -1,529 +0,0 @@ -GridControl | xrm-ex
-
- -
-
-
-
- -

Class GridControl

-
-

Interface for a CRM grid control.

-
-
-

See

Control

-
-
-

Hierarchy

-
    -
  • GridControl
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
- -
-
-

Properties

-
- -
Name: string
-
- -
_gridControl?: Xrm.Controls.GridControl
-
-

Accessors

-
- -
-
- -
-
-

Methods

-
- -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the logical name of the table data displayed in the grid.

    -
    -

    Returns string

    The logical name of the table data displayed in the grid.

    - -
-
- -
    - -
  • -

    Gets the FetchXML query that represents the current data, including filtered and sorted data, in the grid control.

    -
    -

    Returns string

    The FetchXML query.

    - -
-
- -
-
- -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
-
- -
-
- -
    - -
  • -

    Gets the URL of the current grid control.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional client: GridClient
      -

      Indicates the client type.

      -
      -
    -

    Returns string

    Gets the URL of the current grid control.

    - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Displays the associated grid for the grid.

    -
    -

    Returns void

    -
    -

    Remarks

    This method does nothing if the grid is not filtered based on a relationship.

    -
-
- -
    - -
  • -

    Refreshes the sub grid.

    -
    -

    Returns void

    -
    -

    Remarks

    Not available during the "on load" event of the form.

    -
-
- -
-
- -
    - -
  • -

    Use this method to remove event handlers from the GridControl's OnLoad event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: (() => void)
      -

      The handler.

      -
      -
      -
        -
      • -
          -
        • (): void
        • -
        • -

          Returns void

    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Class.LookupField.html b/docs/classes/src_XrmEx.XrmEx.Class.LookupField.html deleted file mode 100644 index 1224aea..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.LookupField.html +++ /dev/null @@ -1,953 +0,0 @@ -LookupField | xrm-ex
-
- -
-
-
-
- -

Class LookupField

-
-

Interface a Lookup attribute.

-
-
-

See

Attribute

-
-
-

Hierarchy

-
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
- -
-
-

Properties

-
- -
Name: string
-
- -
-
- -
_customFilters: any = []
-
- -
allFields: Field[] = []
-
-

Accessors

-
- -
-
- -
    -
  • get EntityType(): string
  • -
  • -

    Gets the entityType of the first lookup value

    -
    -

    Returns string

    -
-
- -
    -
  • get FormattedValue(): string
  • -
  • -

    Gets the formatted value of the first lookup value

    -
    -

    Returns string

    -
-
- -
    -
  • get Id(): string
  • -
  • -

    Gets the id of the first lookup value

    -
    -

    Returns string

    -
-
- -
-
- -
-
-

Methods

-
- -
-
- -
-
- -
    - -
  • -

    Adds an additional custom filter to the lookup, with the "AND" filter operator.

    -
    -
    -

    Parameters

    -
      -
    • -
      filterXml: string
    • -
    • -
      Optional entityLogicalName: string
      -

      (Optional) The logical name of the entity.

      -
      -
    -

    Returns LookupField

    -
    -

    Remarks

    If entityLogicalName is not specified, the filter will be applied to all entities - valid for the Lookup control.

    - -

    Example

    Example filter: <filter type="and">
    <condition attribute="address1_city" operator="eq" value="Redmond" />
    </filter> -
    -
-
- -
    - -
  • -

    Adds an additional custom filter to the lookup, with the "AND" filter operator.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      (Optional) The logical name of the entity.

      -
      -
    • -
    • -
      primaryAttributeIdName: string
      -

      (Optional) The logical name of the primary key.

      -
      -
    • -
    • -
      fetchXml: string
      -

      Specifies the FetchXML used to filter.

      -
      -
    -

    Returns Promise<void>

    -
    -

    Remarks

    If entityLogicalName is not specified, the filter will be applied to all entities - valid for the Lookup control.

    - -

    Example

    Example fetchXml: <fetch>
    <entity name="contact">
    <filter>
    <condition attribute="address1_city" operator="eq" value="Redmond" />
    </filter>
    </entity>
    </fetch> -
    -
-
- -
    - -
  • -

    Removes all filters set on the current lookup attribute by using addPreFilterToLookup or addPreFilterToLookupAdvanced

    -
    -

    Returns LookupField

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets a boolean value indicating whether the Lookup is a multi-value PartyList.

    -
    -

    Returns boolean

    true the attribute is a PartyList, otherwise false.

    - -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns LookupField

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
    - -
  • -

    Retrieves an entity record.

    -
    -
    -

    Parameters

    -
      -
    • -
      options: string
      -

      (Optional) OData system query options, $select and $expand, to retrieve your data.

      -
        -
      • Use the $select system query option to limit the properties returned by including a comma-separated -list of property names. This is an important performance best practice. If properties aren’t -specified using $select, all properties will be returned.
      • -
      • Use the $expand system query option to control what data from related entities is returned. If you -just include the name of the navigation property, you’ll receive all the properties for related -records. You can limit the properties returned for related records using the $select system query -option in parentheses after the navigation property name. Use this for both single-valued and -collection-valued navigation properties.
      • -
      • You can also specify multiple query options by using & to separate the query options.
      • -
      -
      -
    -

    Returns Promise<any>

    On success, returns a promise containing a JSON object with the retrieved attributes and their values.

    - -
    -

    Example

    options example:

    -
    options: $select=name&$expand=primarycontactid($select=contactid,fullname)
    -
    - -

    See

    External Link: retrieveRecord (Client API reference)

    -
-
- -
-
- -
-
- -
    - -
  • -

    Sets a lookup with a lookup from the retrieved record.

    -
    -
    -

    Parameters

    -
      -
    • -
      selectName: string
      -
    • -
    • -
      retrievedRecord: {
          [x: string]: any;
      }
      -
      -
        -
      • -
        [x: string]: any
    -

    Returns void

    -
    -

    Example

    var contact = await fields.Contact.retrieve('?$select=_parentcustomerid_value');
    fields.Account.setLookupFromRetrieve('_parentcustomerid_value', contact);
    //Alternate
    fields.Account.setLookupFromRetrieve('parentcustomerid', contact); -
    -
-
- -
    - -
  • -

    Sets the value of a lookup

    -
    -
    -

    Parameters

    -
      -
    • -
      id: string
      -

      Guid of the record

      -
      -
    • -
    • -
      entityType: any
      -

      logicalname of the entity

      -
      -
    • -
    • -
      name: any
      -

      formatted value

      -
      -
    • -
    • -
      append: boolean = false
      -

      if true, adds value to the array instead of replacing it

      -
      -
    -

    Returns LookupField

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns LookupField

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: any
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html b/docs/classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html deleted file mode 100644 index c347809..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.MultiSelectOptionSetField.html +++ /dev/null @@ -1,803 +0,0 @@ -MultiSelectOptionSetField | xrm-ex
-
- -
-
-
-
- -

Class MultiSelectOptionSetField<Options>

-
-

Interface an OptionSet attribute.

-
-
-
-

Type Parameters

-
    -
  • -

    Options extends OptionValues

-
-

Hierarchy

-
    -
  • Field -
      -
    • MultiSelectOptionSetField
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
- -
-
-

Properties

-
- -
Name: string
-
- -
Option: Options
-
- -
-
- -
allFields: Field[] = []
-
-

Accessors

-
- -
-
- -
    -
  • get Value(): number[]
  • -
  • -

    Gets the value.

    -
    -

    Returns number[]

    The value.

    - -
  • -
  • set Value(value): void
  • -
  • -
    -

    Parameters

    -
      -
    • -
      value: number[] | (keyof Options)[]
    -

    Returns void

-
- -
-
-

Methods

-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns MultiSelectOptionSetField<Options>

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: any
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    The getOptions() method returns option values as strings. You must use parseInt - to convert them to numbers before you can use those values to set the value of an - OptionSet attribute. Attributes on Quick Create Forms will not save values set - with this method.

    -
-
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Class.NumberField.html b/docs/classes/src_XrmEx.XrmEx.Class.NumberField.html deleted file mode 100644 index 339b047..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.NumberField.html +++ /dev/null @@ -1,763 +0,0 @@ -NumberField | xrm-ex
-
- -
-
-
-
- -

Class NumberField

-
-

Interface for a Number attribute.

-
-
-

See

Attribute

-
-
-

Hierarchy

-
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
- -
-
-

Properties

-
- -
Name: string
-
- -
-
- -
allFields: Field[] = []
-
-

Accessors

-
- -
-
- -
    -
  • get Value(): number
  • -
  • -

    Gets the value.

    -
    -

    Returns number

    The value.

    - -
  • -
  • set Value(value): void
  • -
  • -
    -

    Parameters

    -
      -
    • -
      value: number
    -

    Returns void

-
- -
-
-

Methods

-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns NumberField

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns NumberField

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: any
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Class.OptionsetField.html b/docs/classes/src_XrmEx.XrmEx.Class.OptionsetField.html deleted file mode 100644 index a28d1c3..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.OptionsetField.html +++ /dev/null @@ -1,880 +0,0 @@ -OptionsetField | xrm-ex
-
- -
-
-
-
- -

Class OptionsetField<Options>

-
-

Interface an OptionSet attribute.

-
-
-
-

Type Parameters

-
    -
  • -

    Options extends OptionValues

-
-

Hierarchy

-
    -
  • Field -
      -
    • OptionsetField
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
- -
-
-

Properties

-
- -
Name: string
-
- -
Option: Options
-
- -
_attribute: Xrm.Attributes.OptionSetAttribute<number>
-
- -
-
- -
allFields: Field[] = []
-
-

Accessors

-
- -
-
- -
    -
  • get Value(): number
  • -
  • -

    Gets the value.

    -
    -

    Returns number

    The value.

    - -
  • -
  • set Value(value): void
  • -
  • -
    -

    Parameters

    -
      -
    • -
      value: number | keyof Options
    -

    Returns void

-
- -
-
- -
-
-

Methods

-
- -
-
- -
-
- -
    - -
  • -

    Adds an option.

    -
    -
    -

    Parameters

    -
      -
    • -
      values: number[]
      -

      an array with the option values to add

      -
      -
    • -
    • -
      Optional index: number
      -

      (Optional) zero-based index of the option.

      -
      -
    -

    Returns OptionsetField<Options>

    -
    -

    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.

    -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns OptionsetField<Options>

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns OptionsetField<Options>

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: any
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    The getOptions() method returns option values as strings. You must use parseInt - to convert them to numbers before you can use those values to set the value of an - OptionSet attribute. Attributes on Quick Create Forms will not save values set - with this method.

    -
-
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Class.Section.html b/docs/classes/src_XrmEx.XrmEx.Class.Section.html deleted file mode 100644 index 892db55..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.Section.html +++ /dev/null @@ -1,287 +0,0 @@ -Section | xrm-ex
-
- -
-
-
-
- -

Class Section

-
-

Interface for a form section.

-
-
-

See

UiElement

-
-
-

Hierarchy

-
    -
  • Section
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
-
-

Accessors

-
-
-

Methods

-
-
-

Constructors

-
- -
-
-

Properties

-
- -
Name: string
-
- -
_section?: Xrm.Controls.Section
-
- - -

A reference to the collection of controls within this tab.

-
-
-
- -
parentTab?: Xrm.Controls.Tab
-
-

Accessors

-
- -
-
-

Methods

-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Class.Tab.html b/docs/classes/src_XrmEx.XrmEx.Class.Tab.html deleted file mode 100644 index 880896b..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.Tab.html +++ /dev/null @@ -1,399 +0,0 @@ -Tab | xrm-ex
-
- -
-
-
-
- -

Class Tab<Sections>

-
-

Interface for a form tab.

-
-
-

See

-
-
-

Type Parameters

-
    -
  • -

    Sections extends TabSections

-
-

Hierarchy

-
    -
  • Tab
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Sections extends TabSections

    -
    -

    Parameters

    -
      -
    • -
      name: string
    • -
    • -
      Optional section: Sections
    -

    Returns XrmEx.Class.Tab<Sections>

-
-

Properties

-
- -
Name: string
-
- -
Section: Sections
-
- -
-
- - -

A reference to the collection of form sections within this tab.

-
-
-
-

Accessors

-
- -
-
-

Methods

-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets the name of the tab.

    -
    -

    Returns string

    The name.

    - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
-
- -
    - -
  • -

    Sets display state of the tab.

    -
    -
    -

    Parameters

    -
      -
    • -
      displayState: Xrm.DisplayState
      -

      Display state of the tab, as either "expanded" or "collapsed"

      -
      -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in the 2021 release wave 1 (April 2021). Use the setFocus method in Unified Interface to ensure the correct tab is opened on a form.

    -
-
- -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Class.TextField.html b/docs/classes/src_XrmEx.XrmEx.Class.TextField.html deleted file mode 100644 index 4084840..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Class.TextField.html +++ /dev/null @@ -1,713 +0,0 @@ -TextField | xrm-ex
-
- -
-
-
-
- -

Class TextField

-
-

Interface for a String attribute.

-
-
-

See

Attribute

-
-
-

Hierarchy

-
-
-

Implements

-
-
-
-
- -
-
-

Constructors

-
- -
-
-

Properties

-
- -
Name: string
-
- -
-
- -
allFields: Field[] = []
-
-

Accessors

-
- -
-
- -
    -
  • get Value(): string
  • -
  • -

    Gets the value.

    -
    -

    Returns string

    The value.

    - -
  • -
  • set Value(value): void
  • -
  • -
    -

    Parameters

    -
      -
    • -
      value: string
    -

    Returns void

-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns TextField

    -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets maximum length allowed.

    -
    -

    Returns number

    The maximum length allowed.

    - -
    -

    Remarks

    The email form's "Description" attribute does not have the this method.

    -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns TextField

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns TextField

    -
-
- -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns TextField

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the required level.

    -
    -
    -

    Parameters

    -
      -
    • -
      required: boolean
      -

      The requirement level, as either false for "none" or true for "required"

      -
      -
    -

    Returns TextField

    -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: any
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    A String field with the email format enforces email - address formatting. Attributes on Quick Create Forms will not save values set - with this method.

    -
-
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Fields.html b/docs/classes/src_XrmEx.XrmEx.Fields.html deleted file mode 100644 index 24c151d..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Fields.html +++ /dev/null @@ -1,456 +0,0 @@ -Fields | xrm-ex
-
- -
-
-
-
- -

Class Fields

-
-

Hierarchy

-
    -
  • Fields
-
-
-
- -
-
-

Constructors

-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      message: string
    • -
    • -
      notificationLevel: "ERROR" | "RECOMMENDATION"
    • -
    • -
      uniqueId: string
    • -
    • -
      Optional actions: Xrm.Controls.ControlNotificationAction[]
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds a handler or an array of handlers to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      handler: ChangeEventHandler
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns void

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      handler: ChangeEventHandler
      -

      The handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns void

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the required level.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      required: boolean
      -

      The requirement level, as either false for "none" or true for "required"

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the required level.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      requirementLevel: Xrm.Attributes.RequirementLevel
      -

      The requirement level, as either "none", "required", or "recommended"

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      value: any
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      fields: Field[]
      -

      An array of fields to on which this method should be applied.

      -
      -
    • -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Form.html b/docs/classes/src_XrmEx.XrmEx.Form.html deleted file mode 100644 index b29930f..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Form.html +++ /dev/null @@ -1,382 +0,0 @@ -Form | xrm-ex
-
- -
-
-
-
- -

Class Form

-
-

Represents a form in Dynamics 365.

-
-
-
-

Hierarchy

-
    -
  • Form
-
-
-
- -
-
-

Constructors

-
- -
-
-

Properties

-
- -
_executionContext: Xrm.Events.EventContext
-
- -
_formContext: FormContext
-
-

Accessors

-
- -
    -
  • get IsCreate(): boolean
  • -
  • -

    Returns true if form is from type create

    -
    -

    Returns boolean

    -
-
- -
    -
  • get IsNotCreate(): boolean
  • -
  • -

    Returns true if form is not from type create

    -
    -

    Returns boolean

    -
-
- -
    -
  • get IsNotUpdate(): boolean
  • -
  • -

    Returns true if form is not from type update

    -
    -

    Returns boolean

    -
-
- -
    -
  • get IsUpdate(): boolean
  • -
  • -

    Returns true if form is from type update

    -
    -

    Returns boolean

    -
-
- -
-
- -
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays a form level notification. Any number of notifications can be displayed and will remain until removed using clearFormNotification. -The height of the notification area is limited so each new message will be added to the top.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The text of the notification message.

      -
      -
    • -
    • -
      level: Xrm.FormNotificationLevel
      -

      The level of the notification which defines how the message will be displayed, such as the icon. -ERROR: Notification will use the system error icon. -WARNING: Notification will use the system warning icon. -INFO: Notification will use the system info icon.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier for the notification which is used with clearFormNotification to remove the notification.

      -
      -
    -

    Returns boolean

    true if it succeeds, othenprwise false.

    - -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Clears the form notification described by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    True if it succeeds, otherwise false.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/classes/src_XrmEx.XrmEx.Process.html b/docs/classes/src_XrmEx.XrmEx.Process.html deleted file mode 100644 index 6c7634e..0000000 --- a/docs/classes/src_XrmEx.XrmEx.Process.html +++ /dev/null @@ -1,511 +0,0 @@ -Process | xrm-ex
-
- -
-
-
-
- -

Class Process

-
-

Hierarchy

-
    -
  • Process
-
-
-
- -
-
-

Constructors

-
- -
-
-

Accessors

-
- -
-
- -
-
-

Methods

-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnPreProcessStatusChange event so that it will be called before the -business process flow status changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: Xrm.Events.ProcessStatusChangeHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnPreStageChange event so that it will be called before the -business process flow stage changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnPreProcessStatusChange event so that it will be called when the -business process flow status changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: Xrm.Events.ProcessStatusChangeHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnStageChange event so that it will be called when the -business process flow stage changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnStageSelected event so that it will be called -when a business process flow stage is selected.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: Xrm.Events.ContextSensitiveHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnPreProcessStatusChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnPreStageChange event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      If an anonymous function is set using the addOnPreStageChange method it - cannot be removed using this method.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnProcessStatusChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnStageChange event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      If an anonymous function is set using the addOnStageChange method it - cannot be removed using this method.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnStageChange event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: Xrm.Events.ContextSensitiveHandler
      -

      If an anonymous function is set using the addOnStageChange method it - cannot be removed using this method.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
-
- -
-
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.AdvancedConfigSettingOption.html b/docs/enums/node_modules__types_xrm.XrmEnum.AdvancedConfigSettingOption.html deleted file mode 100644 index d168d03..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.AdvancedConfigSettingOption.html +++ /dev/null @@ -1,126 +0,0 @@ -AdvancedConfigSettingOption | xrm-ex
-
- -
-
-
-
- -

Enumeration AdvancedConfigSettingOptionConst

-
-

Constant Enum: Settings for GlobalContext.getAdvancedConfigSetting globalContext.getAdvancedConfigSetting(setting)

-
-
-
-
-
- -
-
-

Enumeration Members

-
- -
MaxChildIncidentNumber: "MaxChildIncidentNumber"
-
- -
MaxIncidentMergeNumber: "MaxIncidentMergeNumber"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.AppNotificationLevel.html b/docs/enums/node_modules__types_xrm.XrmEnum.AppNotificationLevel.html deleted file mode 100644 index a2e46ed..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.AppNotificationLevel.html +++ /dev/null @@ -1,142 +0,0 @@ -AppNotificationLevel | xrm-ex
-
- -
-
-
-
- -

Enumeration AppNotificationLevelConst

-
-

Constant Enum: App Notification Levels for App.addGlobalNotification Xrm.App.addGlobalNotification().

-
-
-

See

Xrm.AppNotificationLevel

-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Error: 2
-
- -
Information: 4
-
- -
Success: 1
-
- -
Warning: 3
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.AttributeRequiredLevel.html b/docs/enums/node_modules__types_xrm.XrmEnum.AttributeRequiredLevel.html deleted file mode 100644 index c1ebd8d..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.AttributeRequiredLevel.html +++ /dev/null @@ -1,140 +0,0 @@ -AttributeRequiredLevel | xrm-ex
-
- -
-
-
-
- -

Enumeration AttributeRequiredLevelConst

-
-

An enumeration for Attribute required level metadata

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
ApplicationRequired: 2
-
- -
None: 0
-
- -
Recommended: 3
-
- -
SystemRequired: 1
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.AttributeRequirementLevel.html b/docs/enums/node_modules__types_xrm.XrmEnum.AttributeRequirementLevel.html deleted file mode 100644 index 5e58204..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.AttributeRequirementLevel.html +++ /dev/null @@ -1,136 +0,0 @@ -AttributeRequirementLevel | xrm-ex
-
- -
-
-
-
- -

Enumeration AttributeRequirementLevelConst

-
-

Constant Enum: Requirement Level for Attributes.Attribute.getRequiredLevel Attributes.Attribute.getRequiredLevel() and -Attributes.Attribute.setRequiredLevel Attributes.Attribute.setRequiredLevel().

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
None: "none"
-
- -
Recommended: "recommended"
-
- -
Required: "required"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.AttributeType.html b/docs/enums/node_modules__types_xrm.XrmEnum.AttributeType.html deleted file mode 100644 index a3b4eff..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.AttributeType.html +++ /dev/null @@ -1,191 +0,0 @@ -AttributeType | xrm-ex
-
- -
-
-
-
- -

Enumeration AttributeTypeConst

-
-

Constant Enum: Attribute types for Attributes.Attribute.setDisplayState().

-
-
-
-
-
- -
-
-

Enumeration Members

-
- -
Boolean: "boolean"
-
- -
DateTime: "datetime"
-
- -
Decimal: "decimal"
-
- -
Double: "double"
-
- -
Integer: "integer"
-
- -
Lookup: "lookup"
-
- -
Memo: "memo"
-
- -
Money: "money"
-
- -
MultiOptionSet: "multiselectoptionset"
-
- -
OptionSet: "optionset"
-
- -
String: "string"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.AttributeTypeCode.html b/docs/enums/node_modules__types_xrm.XrmEnum.AttributeTypeCode.html deleted file mode 100644 index 7799b0c..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.AttributeTypeCode.html +++ /dev/null @@ -1,259 +0,0 @@ -AttributeTypeCode | xrm-ex
-
- -
-
-
-
- -

Enumeration AttributeTypeCodeConst

-
-

An enumeration for Attribute Type metadata

-
-
-
-
-
- -
-
-

Enumeration Members

-
- -
BigInt: 18
-
- -
Boolean: 0
-
- -
CalendarRules: 16
-
- -
Customer: 1
-
- -
DateTime: 2
-
- -
Decimal: 3
-
- -
Double: 4
-
- -
EntityName: 20
-
- -
Integer: 5
-
- -
Lookup: 6
-
- -
ManagedProperty: 19
-
- -
Memo: 7
-
- -
Money: 8
-
- -
Owner: 9
-
- -
PartyList: 10
-
- -
Picklist: 11
-
- -
State: 12
-
- -
Status: 13
-
- -
String: 14
-
- -
Uniqueidentifier: 15
-
- -
Virtual: 17
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.Client.html b/docs/enums/node_modules__types_xrm.XrmEnum.Client.html deleted file mode 100644 index 7a73b97..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.Client.html +++ /dev/null @@ -1,149 +0,0 @@ -Client | xrm-ex
-
- -
-
-
-
- -

Enumeration ClientConst

-
-

Constant Enum: Client Types for ClientContext.getClient clientContext.getClient().

-
-
-

See

Client

-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Mobile: "Mobile"
-
- -
Outlook: "Outlook"
-
- -
USD: "UnifiedServiceDesk"
-
- -
UnifiedServiceDesk: "UnifiedServiceDesk"
-
- -
Web: "Web"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.ClientFormFactor.html b/docs/enums/node_modules__types_xrm.XrmEnum.ClientFormFactor.html deleted file mode 100644 index 27453b4..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.ClientFormFactor.html +++ /dev/null @@ -1,136 +0,0 @@ -ClientFormFactor | xrm-ex
-
- -
-
-
-
- -

Enumeration ClientFormFactorConst

-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Desktop: 1
-
- -
Phone: 3
-
- -
Tablet: 2
-
- -
Unknown: 0
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.ClientState.html b/docs/enums/node_modules__types_xrm.XrmEnum.ClientState.html deleted file mode 100644 index 8a8282b..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.ClientState.html +++ /dev/null @@ -1,128 +0,0 @@ -ClientState | xrm-ex
-
- -
-
-
-
- -

Enumeration ClientStateConst

-
-

Constant Enum: Client States for clientContext.getClientState().

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Offline: "Offline"
-
- -
Online: "Online"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.CmdBarDisplay.html b/docs/enums/node_modules__types_xrm.XrmEnum.CmdBarDisplay.html deleted file mode 100644 index 33575d6..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.CmdBarDisplay.html +++ /dev/null @@ -1,128 +0,0 @@ -CmdBarDisplay | xrm-ex
-
- -
-
-
-
- -

Enumeration CmdBarDisplayConst

-
-

Constant Enum: Command Bar Display options for Xrm.Url.FormOpenParameters.cmdbar, Xrm.Url.ViewOpenParameters.cmdbar, and Xrm.Utility.FormOpenParameters.cmdbar.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
False: "false"
-
- -
True: "true"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.DateAttributeFormat.html b/docs/enums/node_modules__types_xrm.XrmEnum.DateAttributeFormat.html deleted file mode 100644 index a8c924e..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.DateAttributeFormat.html +++ /dev/null @@ -1,128 +0,0 @@ -DateAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Enumeration DateAttributeFormatConst

-
-

Constant Enum: Date attribute formats for Attributes.Attribute.getFormat(), used by Attributes.DateAttribute DateAttribute.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Date: "date"
-
- -
DateTime: "datetime"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.DevicePickFileType.html b/docs/enums/node_modules__types_xrm.XrmEnum.DevicePickFileType.html deleted file mode 100644 index 79df26a..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.DevicePickFileType.html +++ /dev/null @@ -1,135 +0,0 @@ -DevicePickFileType | xrm-ex
-
- -
-
-
-
- -

Enumeration DevicePickFileTypeConst

-
-

Constant Enum: Possible file types for Xrm.Device.pickFile options

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Audio: "audio"
-
- -
Image: "image"
-
- -
Video: "video"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.DisplayState.html b/docs/enums/node_modules__types_xrm.XrmEnum.DisplayState.html deleted file mode 100644 index 457dbc1..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.DisplayState.html +++ /dev/null @@ -1,128 +0,0 @@ -DisplayState | xrm-ex
-
- -
-
-
-
- -

Enumeration DisplayStateConst

-
-

Constant Enum: Display States for setDisplayState() on Controls.ProcessControl.setDisplayState Processes and Controls.Tab.setDisplayState Tabs.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Collapsed: "collapsed"
-
- -
Expanded: "expanded"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.EntitySaveMode.html b/docs/enums/node_modules__types_xrm.XrmEnum.EntitySaveMode.html deleted file mode 100644 index 4100147..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.EntitySaveMode.html +++ /dev/null @@ -1,132 +0,0 @@ -EntitySaveMode | xrm-ex
-
- -
-
-
-
- -

Enumeration EntitySaveModeConst

-
-

Constant Enum: Entity.save Entity Save Modes

-
-
-

See

-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
SaveAndClose: "saveandclose"
-
- -
SaveAndNew: "saveandnew"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.FormDataLoadState.html b/docs/enums/node_modules__types_xrm.XrmEnum.FormDataLoadState.html deleted file mode 100644 index b739e15..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.FormDataLoadState.html +++ /dev/null @@ -1,135 +0,0 @@ -FormDataLoadState | xrm-ex
-
- -
-
-
-
- -

Enumeration FormDataLoadStateConst

-
-

Possible state of form data load.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
InitialLoad: 1
-
- -
Refresh: 3
-
- -
Save: 2
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.FormNotificationLevel.html b/docs/enums/node_modules__types_xrm.XrmEnum.FormNotificationLevel.html deleted file mode 100644 index 68e1e57..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.FormNotificationLevel.html +++ /dev/null @@ -1,135 +0,0 @@ -FormNotificationLevel | xrm-ex
-
- -
-
-
-
- -

Enumeration FormNotificationLevelConst

-
-

Constant Enum: Form Notification Levels for Ui.setFormNotification formContext.ui.setFormNotification().

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Error: "ERROR"
-
- -
Info: "INFO"
-
- -
Warning: "WARNING"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.FormType.html b/docs/enums/node_modules__types_xrm.XrmEnum.FormType.html deleted file mode 100644 index 1ad9c53..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.FormType.html +++ /dev/null @@ -1,174 +0,0 @@ -FormType | xrm-ex
-
- -
-
-
-
- -

Enumeration FormTypeConst

-
-

Enumeration of entity form states/types.

-
-
-
-
-
- -
-
-

Enumeration Members

-
- -
BulkEdit: 6
-
- -
Create: 1
-
- -
Disabled: 4
-
- -
QuickCreate: 5
-
-

Deprecated

QuickCreate has been deprecated

-
-
- -
ReadOnly: 3
-
- -
ReadOptimized: 11
-
-

Deprecated

ReadOptimized has been deprecated.

-
-
- -
Undefined: 0
-
- -
Update: 2
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.GridClient.html b/docs/enums/node_modules__types_xrm.XrmEnum.GridClient.html deleted file mode 100644 index eeb5b2d..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.GridClient.html +++ /dev/null @@ -1,126 +0,0 @@ -GridClient | xrm-ex
-
- -
-
-
-
- -

Enumeration GridClientConst

-
-

Enumeration of grid client type

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Browser: 0
-
- -
MobileApplication: 1
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.GridControlContext.html b/docs/enums/node_modules__types_xrm.XrmEnum.GridControlContext.html deleted file mode 100644 index 7f26681..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.GridControlContext.html +++ /dev/null @@ -1,147 +0,0 @@ -GridControlContext | xrm-ex
-
- -
-
-
-
- -

Enumeration GridControlContextConst

-
-

Enumeration of grid control context resolutions.

-
-
-
-
-
- -
-
-

Enumeration Members

-
- -
FormContextRelated: 4
-
- -
FormContextUnrelated: 3
-
- -
RibbonContextForm: 1
-
- -
RibbonContextListing: 2
-
- -
Unknown: 0
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.IntegerAttributeFormat.html b/docs/enums/node_modules__types_xrm.XrmEnum.IntegerAttributeFormat.html deleted file mode 100644 index b527b83..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.IntegerAttributeFormat.html +++ /dev/null @@ -1,128 +0,0 @@ -IntegerAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Enumeration IntegerAttributeFormatConst

-
-

Constant Enum: Integer attribute formats for Attributes.Attribute.getFormat(), used by Attributes.NumberAttribute NumberAttribute.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Duration: "duration"
-
- -
None: "none"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.NavBarDisplay.html b/docs/enums/node_modules__types_xrm.XrmEnum.NavBarDisplay.html deleted file mode 100644 index fee1e3f..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.NavBarDisplay.html +++ /dev/null @@ -1,135 +0,0 @@ -NavBarDisplay | xrm-ex
-
- -
-
-
-
- -

Enumeration NavBarDisplayConst

-
-

Constant Enum: Navigation Bar Display options for Xrm.Url.FormOpenParameters.navbar, Xrm.Url.ViewOpenParameters.navbar, and Xrm.Utility.FormOpenParameters.navbar.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Entity: "entity"
-
- -
Off: "off"
-
- -
On: "on"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.OpenFileOptions.html b/docs/enums/node_modules__types_xrm.XrmEnum.OpenFileOptions.html deleted file mode 100644 index a2bab72..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.OpenFileOptions.html +++ /dev/null @@ -1,126 +0,0 @@ -OpenFileOptions | xrm-ex
-
- -
-
-
-
- -

Enumeration OpenFileOptionsConst

-
-

An enumeration for open file dialog options

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Open: 1
-
- -
Save: 2
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.OpenSearchResultMode.html b/docs/enums/node_modules__types_xrm.XrmEnum.OpenSearchResultMode.html deleted file mode 100644 index bae4b60..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.OpenSearchResultMode.html +++ /dev/null @@ -1,122 +0,0 @@ -OpenSearchResultMode | xrm-ex
-
- -
-
-
-
- -

Enumeration OpenSearchResultModeConst

-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Inline: "Inline"
-
- -
Popup: "Popup"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.OptionSetAttributeFormat.html b/docs/enums/node_modules__types_xrm.XrmEnum.OptionSetAttributeFormat.html deleted file mode 100644 index d686c90..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.OptionSetAttributeFormat.html +++ /dev/null @@ -1,128 +0,0 @@ -OptionSetAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Enumeration OptionSetAttributeFormatConst

-
-

Constant Enum: OptionSet attribute formats for Attributes.Attribute.getFormat(), used by Attributes.OptionSetAttribute OptionSetAttribute.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Language: "language"
-
- -
TimeZone: "timezone"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.ProcessStatus.html b/docs/enums/node_modules__types_xrm.XrmEnum.ProcessStatus.html deleted file mode 100644 index 4538589..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.ProcessStatus.html +++ /dev/null @@ -1,135 +0,0 @@ -ProcessStatus | xrm-ex
-
- -
-
-
-
- -

Enumeration ProcessStatusConst

-
-

Constant Enum: Status for ProcessFlow.Process.getStatus Process.getStatus().

-
-
-

See

ProcessFlow.ProcessStatus

-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Aborted: "aborted"
-
- -
Active: "active"
-
- -
Finished: "finished"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.RelationshipType.html b/docs/enums/node_modules__types_xrm.XrmEnum.RelationshipType.html deleted file mode 100644 index 72573d0..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.RelationshipType.html +++ /dev/null @@ -1,126 +0,0 @@ -RelationshipType | xrm-ex
-
- -
-
-
-
- -

Enumeration RelationshipTypeConst

-
-

An enumeration for Relationship Type Metadata

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
ManyToMany: 1
-
- -
OneToMany: 0
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.ReportAction.html b/docs/enums/node_modules__types_xrm.XrmEnum.ReportAction.html deleted file mode 100644 index fdacb5d..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.ReportAction.html +++ /dev/null @@ -1,128 +0,0 @@ -ReportAction | xrm-ex
-
- -
-
-
-
- -

Enumeration ReportActionConst

-
-

Constant Enum: Report Open Action options for Xrm.Url.ReportOpenParameters.actions.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Filter: "filter"
-
- -
Run: "run"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.RoleType.html b/docs/enums/node_modules__types_xrm.XrmEnum.RoleType.html deleted file mode 100644 index b57330f..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.RoleType.html +++ /dev/null @@ -1,126 +0,0 @@ -RoleType | xrm-ex
-
- -
-
-
-
- -

Enumeration RoleTypeConst

-
-

An enumeration for Relationship Role Type Metadata

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
AssociationEntity: 2
-
- -
Referencing: 1
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.SaveMode.html b/docs/enums/node_modules__types_xrm.XrmEnum.SaveMode.html deleted file mode 100644 index eb2b6a7..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.SaveMode.html +++ /dev/null @@ -1,189 +0,0 @@ -SaveMode | xrm-ex
-
- -
-
-
-
- -

Enumeration SaveModeConst

-
-

Enumeration of entity form save modes.

-
-
-
-
-
- -
-
-

Enumeration Members

-
- -
Assign: 47
-
- -
AutoSave: 70
-
- -
Deactivate: 5
-
- -
Disqualify: 15
-
- -
Qualify: 16
-
- -
Reactivate: 6
-
- -
Save: 1
-
- -
SaveAndClose: 2
-
- -
SaveAndNew: 59
-
- -
SaveAsCompleted: 58
-
- -
Send: 7
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.StageCategory.html b/docs/enums/node_modules__types_xrm.XrmEnum.StageCategory.html deleted file mode 100644 index bff2984..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.StageCategory.html +++ /dev/null @@ -1,161 +0,0 @@ -StageCategory | xrm-ex
-
- -
-
-
-
- -

Enumeration StageCategoryConst

-
-

Enumeration of stage categories.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Close: 3
-
- -
Develop: 1
-
- -
Identify: 4
-
- -
Propose: 2
-
- -
Qualify: 0
-
- -
Research: 5
-
- -
Resolve: 6
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.StageChangeDirection.html b/docs/enums/node_modules__types_xrm.XrmEnum.StageChangeDirection.html deleted file mode 100644 index 5b837d3..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.StageChangeDirection.html +++ /dev/null @@ -1,128 +0,0 @@ -StageChangeDirection | xrm-ex
-
- -
-
-
-
- -

Enumeration StageChangeDirectionConst

-
-

Constant Enum: Direction types for a process stage change event

-
-
-

See

ProcessFlow.StageChangeDirection

-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Next: "Next"
-
- -
Previous: "Previous"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.StageStatus.html b/docs/enums/node_modules__types_xrm.XrmEnum.StageStatus.html deleted file mode 100644 index 32c8e0d..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.StageStatus.html +++ /dev/null @@ -1,128 +0,0 @@ -StageStatus | xrm-ex
-
- -
-
-
-
- -

Enumeration StageStatusConst

-
-

Constant Enum: Status for ProcessFlow.Stage.getStatus Stage.getStatus().

-
-
-

See

ProcessFlow.StageStatus

-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Active: "active"
-
- -
Inactive: "inactive"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.StandardControlType.html b/docs/enums/node_modules__types_xrm.XrmEnum.StandardControlType.html deleted file mode 100644 index 4df45ac..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.StandardControlType.html +++ /dev/null @@ -1,198 +0,0 @@ -StandardControlType | xrm-ex
-
- -
-
-
-
- -

Enumeration StandardControlTypeConst

-
-

Constant Enum: Control types for Controls.Control.getControlType Controls.Control.getControlType().

-
-
-
-
-
- -
-
-

Enumeration Members

-
- -
IFrame: "iframe"
-
- -
KBSearch: "kbsearch"
-
- -
Lookup: "lookup"
-
- -
MultiSelectOptionSet: "multiselectoptionset"
-
- -
Notes: "notes"
-
- -
OptionSet: "optionset"
-
- -
QuickForm: "quickform"
-
- -
Standard: "standard"
-
- -
SubGrid: "subgrid"
-
- -
TimeLineWall: "timelinewall"
-
- -
TimerControl: "timercontrol"
-
- -
WebResource: "webresource"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.StringAttributeFormat.html b/docs/enums/node_modules__types_xrm.XrmEnum.StringAttributeFormat.html deleted file mode 100644 index d388114..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.StringAttributeFormat.html +++ /dev/null @@ -1,156 +0,0 @@ -StringAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Enumeration StringAttributeFormatConst

-
-

Constant Enum: String attribute formats for Attributes.Attribute.getFormat(), used by Attributes.StringAttribute StringAttribute.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Email: "email"
-
- -
Phone: "phone"
-
- -
Text: "text"
-
- -
TextArea: "textarea"
-
- -
TickerSymbol: "tickersymbol"
-
- -
URL: "url"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.SubmitMode.html b/docs/enums/node_modules__types_xrm.XrmEnum.SubmitMode.html deleted file mode 100644 index e1c9078..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.SubmitMode.html +++ /dev/null @@ -1,135 +0,0 @@ -SubmitMode | xrm-ex
-
- -
-
-
-
- -

Enumeration SubmitModeConst

-
-

Constant Enum: Submit Modes for Attributes.Attribute.setSubmitMode Attributes.Attribute.setSubmitMode().

-
-
-

See

SubmitMode

-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Always: "always"
-
- -
Dirty: "dirty"
-
- -
Never: "never"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.Theme.html b/docs/enums/node_modules__types_xrm.XrmEnum.Theme.html deleted file mode 100644 index 333884b..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.Theme.html +++ /dev/null @@ -1,135 +0,0 @@ -Theme | xrm-ex
-
- -
-
-
-
- -

Enumeration ThemeConst

-
-

Constant Enum: Themes for GlobalContext.getCurrentTheme globalContext.getCurrentTheme().

-
-
-

Remarks

getCurrentTheme() does not work with Dynamics CRM for tablets or in the unified interface.

-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Default: "default"
-
- -
Office12Blue: "Office12Blue"
-
- -
Office14Silver: "Office14Silver"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.ViewType.html b/docs/enums/node_modules__types_xrm.XrmEnum.ViewType.html deleted file mode 100644 index 1cb9ba0..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.ViewType.html +++ /dev/null @@ -1,126 +0,0 @@ -ViewType | xrm-ex
-
- -
-
-
-
- -

Enumeration ViewTypeConst

-
-

An enumeration for view types.

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
SystemView: 1039
-
- -
UserView: 4230
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/enums/node_modules__types_xrm.XrmEnum.WindowPositions.html b/docs/enums/node_modules__types_xrm.XrmEnum.WindowPositions.html deleted file mode 100644 index 915551a..0000000 --- a/docs/enums/node_modules__types_xrm.XrmEnum.WindowPositions.html +++ /dev/null @@ -1,126 +0,0 @@ -WindowPositions | xrm-ex
-
- -
-
-
-
- -

Enumeration WindowPositionsConst

-
-

An enumeration for window positions when opening a new window

-
-
-
-
-
- -
-
-

Enumeration Members

-
-
-

Enumeration Members

-
- -
Center: 1
-
- -
Side: 2
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/node_modules__types_xrm.GetGlobalContext.html b/docs/functions/node_modules__types_xrm.GetGlobalContext.html deleted file mode 100644 index 3f46bf4..0000000 --- a/docs/functions/node_modules__types_xrm.GetGlobalContext.html +++ /dev/null @@ -1,64 +0,0 @@ -GetGlobalContext | xrm-ex
-
- -
-
-
-
- -

Function GetGlobalContext

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.addGlobalNotification.html b/docs/functions/src_XrmEx.XrmEx.addGlobalNotification.html deleted file mode 100644 index 70fb12e..0000000 --- a/docs/functions/src_XrmEx.XrmEx.addGlobalNotification.html +++ /dev/null @@ -1,95 +0,0 @@ -addGlobalNotification | xrm-ex
-
- -
-
-
-
- -

Function addGlobalNotification

-
-
    - -
  • -

    Displays a notification for an app with the given message and level, and lets you specify whether to show a close button.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message to display in the notification.

      -
      -
    • -
    • -
      level: "SUCCESS" | "ERROR" | "WARNING" | "INFO"
      -

      The level of the notification. Can be 'SUCCESS', 'ERROR', 'WARNING', or 'INFO'.

      -
      -
    • -
    • -
      Optional showCloseButton: boolean = false
      -

      Whether to show a close button on the notification. Defaults to false.

      -
      -
    -

    Returns Promise<string>

      -
    • A promise that resolves with the ID of the created notification.
    • -
    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.asPromise.html b/docs/functions/src_XrmEx.XrmEx.asPromise.html deleted file mode 100644 index 3e89c90..0000000 --- a/docs/functions/src_XrmEx.XrmEx.asPromise.html +++ /dev/null @@ -1,98 +0,0 @@ -asPromise | xrm-ex
-
- -
-
-
-
- -

Function asPromise

-
-
    - -
  • -

    Wraps a function that takes a callback as its last parameter and returns a Promise.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      fn: Function
      -

      the function to wrap

      -
      -
    • -
    • -
      context: any
      -

      the parent property of the function f.e. formContext.data.process for formContext.data.process.getEnabledProcesses

      -
      -
    • -
    • -
      Rest ...args: any[]
      -

      the arguments to pass to the function

      -
      -
    -

    Returns Promise<T>

    a Promise that resolves with the callback response

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.checkRequestParameterType.html b/docs/functions/src_XrmEx.XrmEx.checkRequestParameterType.html deleted file mode 100644 index 31566b1..0000000 --- a/docs/functions/src_XrmEx.XrmEx.checkRequestParameterType.html +++ /dev/null @@ -1,86 +0,0 @@ -checkRequestParameterType | xrm-ex
-
- -
-
-
-
- -

Function checkRequestParameterType

-
-
    - -
  • -

    Checks if the given request parameter is of a supported type and has a valid value.

    -
    -
    -

    Parameters

    -
      -
    • -
      requestParameter: RequestParameter
      -

      The request parameter to check.

      -
      -
    -

    Returns void

    -
    -

    Throws

      -
    • Throws an error if the request parameter is not of a supported type or has an invalid value.
    • -
    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.executeAction.html b/docs/functions/src_XrmEx.XrmEx.executeAction.html deleted file mode 100644 index c0fb11e..0000000 --- a/docs/functions/src_XrmEx.XrmEx.executeAction.html +++ /dev/null @@ -1,99 +0,0 @@ -executeAction | xrm-ex
-
- -
-
-
-
- -

Function executeAction

-
-
    - -
  • -

    Executes an Action.

    -
    -
    -

    Parameters

    -
      -
    • -
      actionName: string
      -

      The unique name of the action.

      -
      -
    • -
    • -
      requestParameters: RequestParameter[]
      -

      An array of objects with the parameter name, type and value.

      -
      -
    • -
    • -
      Optional boundEntity: EntityReference
      -

      An optional EntityReference of the bound entity.

      -
      -
    -

    Returns Promise<any>

      -
    • A Promise with the request response.
    • -
    - -
    -

    Throws

      -
    • Throws an error if the request parameter is not of a supported type or has an invalid value.
    • -
    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.executeFunction.html b/docs/functions/src_XrmEx.XrmEx.executeFunction.html deleted file mode 100644 index 0426acd..0000000 --- a/docs/functions/src_XrmEx.XrmEx.executeFunction.html +++ /dev/null @@ -1,99 +0,0 @@ -executeFunction | xrm-ex
-
- -
-
-
-
- -

Function executeFunction

-
-
    - -
  • -

    Executes a Function.

    -
    -
    -

    Parameters

    -
      -
    • -
      functionName: string
      -

      The unique name of the function.

      -
      -
    • -
    • -
      requestParameters: RequestParameter[]
      -

      An array of objects with the parameter name, type and value.

      -
      -
    • -
    • -
      Optional boundEntity: EntityReference
      -

      An optional EntityReference of the bound entity.

      -
      -
    -

    Returns Promise<any>

      -
    • A Promise with the request response.
    • -
    - -
    -

    Throws

      -
    • Throws an error if the request parameter is not of a supported type or has an invalid value.
    • -
    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.getEnvironmentVariableValue.html b/docs/functions/src_XrmEx.XrmEx.getEnvironmentVariableValue.html deleted file mode 100644 index 29a5511..0000000 --- a/docs/functions/src_XrmEx.XrmEx.getEnvironmentVariableValue.html +++ /dev/null @@ -1,87 +0,0 @@ -getEnvironmentVariableValue | xrm-ex
-
- -
-
-
-
- -

Function getEnvironmentVariableValue

-
-
    - -
  • -

    Retrieves the value of an environment variable by using its schema name as key. -If the environment variable has both a default value and a current value, this function will retrieve the current value.

    -
    -
    -

    Parameters

    -
      -
    • -
      environmentVariableSchemaName: string
      -

      The schema name of the environment variable to retrieve.

      -
      -
    -

    Returns Promise<string>

      -
    • A promise that resolves with the value of the environment variable.
    • -
    - -
    -

    Async

-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.getFunctionName.html b/docs/functions/src_XrmEx.XrmEx.getFunctionName.html deleted file mode 100644 index e87a7f7..0000000 --- a/docs/functions/src_XrmEx.XrmEx.getFunctionName.html +++ /dev/null @@ -1,77 +0,0 @@ -getFunctionName | xrm-ex
-
- -
-
-
-
- -

Function getFunctionName

-
-
    - -
  • -

    Returns the name of the calling function.

    -
    -

    Returns string

      -
    • The name of the calling function.
    • -
    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.normalizeGuid.html b/docs/functions/src_XrmEx.XrmEx.normalizeGuid.html deleted file mode 100644 index 47f3d04..0000000 --- a/docs/functions/src_XrmEx.XrmEx.normalizeGuid.html +++ /dev/null @@ -1,85 +0,0 @@ -normalizeGuid | xrm-ex
-
- -
-
-
-
- -

Function normalizeGuid

-
-
    - -
  • -

    Makes a GUID lowercase and removes brackets.

    -
    -
    -

    Parameters

    -
      -
    • -
      guid: string
      -

      The GUID to normalize.

      -
      -
    -

    Returns string

      -
    • The normalized GUID.
    • -
    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.openAlertDialog.html b/docs/functions/src_XrmEx.XrmEx.openAlertDialog.html deleted file mode 100644 index d1718c8..0000000 --- a/docs/functions/src_XrmEx.XrmEx.openAlertDialog.html +++ /dev/null @@ -1,90 +0,0 @@ -openAlertDialog | xrm-ex
-
- -
-
-
-
- -

Function openAlertDialog

-
-
    - -
  • -

    Opens a dialog with dynamic height and width based on text content.

    -
    -
    -

    Parameters

    -
      -
    • -
      title: string
      -

      The title of the dialog.

      -
      -
    • -
    • -
      text: string
      -

      The text content of the dialog.

      -
      -
    -

    Returns Promise<any>

      -
    • A Promise with the dialog response.
    • -
    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.removeGlobalNotification.html b/docs/functions/src_XrmEx.XrmEx.removeGlobalNotification.html deleted file mode 100644 index dbedf72..0000000 --- a/docs/functions/src_XrmEx.XrmEx.removeGlobalNotification.html +++ /dev/null @@ -1,85 +0,0 @@ -removeGlobalNotification | xrm-ex
-
- -
-
-
-
- -

Function removeGlobalNotification

-
-
    - -
  • -

    Clears a notification in the app with the given unique ID.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      The unique ID of the notification to clear.

      -
      -
    -

    Returns Promise<string>

      -
    • A promise that resolves when the notification has been cleared.
    • -
    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/src_XrmEx.XrmEx.throwError.html b/docs/functions/src_XrmEx.XrmEx.throwError.html deleted file mode 100644 index eb3a6d0..0000000 --- a/docs/functions/src_XrmEx.XrmEx.throwError.html +++ /dev/null @@ -1,86 +0,0 @@ -throwError | xrm-ex
-
- -
-
-
-
- -

Function throwError

-
-
    - -
  • -

    Throws an error with the given error message.

    -
    -
    -

    Parameters

    -
      -
    • -
      errorMessage: string
      -

      The error message to throw.

      -
      -
    -

    Returns never

    -
    -

    Throws

      -
    • Always throws an error with the given error message.
    • -
    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index b8ba74a..0000000 --- a/docs/index.html +++ /dev/null @@ -1,177 +0,0 @@ -xrm-ex
-
- -
-
-
-
-

xrm-ex

-

NPM -NPM -GitHub Workflow Status

-

NPM

-

Xrm-Ex: Dynamics 365 Xrm Extensions

A robust framework tailored for Dynamics 365 Client API. While crafted with TypeScript principles in mind, it's essential to understand that XrmEx is primarily designed for JavaScript usage. Our primary goal is to simplify the interaction with the formContext and the Xrm Object. By doing so, we aim to reduce the code you pen down, ensuring your codebase remains maintainable and less prone to errors.

-

XrmEx offers a comprehensive suite of wrappers that seamlessly integrate the Dynamics 365 Client API, ensuring developers have a smooth experience. Dive into XrmEx and elevate your productivity, channeling your energy into crafting exceptional applications.

-

Installation

XrmEx can be easily installed via npm:

-
npm install xrm-ex
-
-

Documentation

For a comprehensive guide to using XrmEx, please check out the full documentation.

-

Getting Started

Set up Project

https://github.com/AhashSritharan/Xrm-Ex/assets/63707488/750cd578-e174-43b0-8783-149599db3da5

-

Deployment

https://github.com/AhashSritharan/Xrm-Ex/assets/63707488/34e2642d-0d73-4964-a5c5-6c035a474773

-

To get started with XrmEx, use the Template below. Add XrmEx.js from your node_modules to your Dynamics 365 form as a library. Execute the method YourNamespace.ContactFunctions.OnLoad in your form and pass the executionContext to that function. -Happy coding!

-
-

Note: Although built with TypeScript, this library is distributed as compiled javascript and its TypeScript declaration. This means it can be used in any javascript file by just referencing the XrmEx.d.ts file. For it to work, you have to add the XrmEx.js file to the Form in Dynamics 365.

-
-

Use the following Starter Template for your JavaScript:

-
/// <reference path="node_modules/xrm-ex/src/XrmEx.d.ts" />
var YourNamespace = YourNamespace || {};
YourNamespace.Contact = YourNamespace.Contact || {};
(function (Self) { //Only properties assigned to the Self object will be exposed to the global scope
class Fields {
Firstname = new XrmEx.Class.TextField("firstname");
Customer = new XrmEx.Class.LookupField("parentcustomerid");
DoNotEmail = new XrmEx.Class.BooleanField("donotemail");
Birthday = new XrmEx.Class.DateField("birthdate");
PreferredContactMethod = new XrmEx.Class.OptionsetField(
"preferredcontactmethodcode",
{
Any: 1,
Email: 2,
Phone: 3,
Fax: 4,
Mail: 5,
}
);
}
class Tabs {
General = new XrmEx.Class.Tab("tab1", {
Section1: new XrmEx.Class.Section("section1"),
Section2: new XrmEx.Class.Section("section2"),
});
Details = new XrmEx.Class.Tab("tab2", {
Section1: new XrmEx.Class.Section("section1"),
Section2: new XrmEx.Class.Section("section2"),
});
}
class Grids {
ContactSubgrid = new XrmEx.Class.GridControl("Test");
}
/**@type {Xrm.FormContext}*/ var formContext;
/**@type {Fields}*/ var fields;
/**@type {Tabs}*/ var tabs;
/**@type {Grids}*/ var grids;

/**
* @param {Xrm.FormContext | Xrm.Events.EventContext} executionContext
*/
Self.OnLoad = async function OnLoad(executionContext) {
await Init(executionContext); //Ensures XrmEx is only accessed after the OnLoad Event
try {
fields.Firstname.Value = "Joe";
fields.Firstname.setVisible(true).setDisabled(true).setRequired(false);
await XrmEx.openAlertDialog("Success", "Xrm works.");
} catch (error) {
console.error(error);
await XrmEx.openAlertDialog("Error", `Error in ${XrmEx.getFunctionName()}\n` + error.message);
}
};
/**
* @param {Xrm.FormContext | Xrm.Events.EventContext} executionContext
*/
async function Init(executionContext) {
if (!XrmEx) {
let errorMessage = "XrmEx is not loaded. Please make sure you have XrmEx.js loaded in your form.";
console.error(errorMessage);
await Xrm.Navigation.openAlertDialog({ title: "Error", text: errorMessage, });
return;
}
XrmEx.Form.executionContext = executionContext;
formContext = XrmEx.Form.formContext;
fields = new Fields();
tabs = new Tabs();
grids = new Grids();
parent.window.XrmEx = XrmEx;
}

})(YourNamespace.Contact); -
-

Contribution Guidelines

We welcome contributions from the community! If you're interested in contributing, please follow these steps:

-
    -
  1. Fork the repository
  2. -
  3. Create a new branch for your changes
  4. -
  5. Make your changes
  6. -
  7. Submit a pull request
  8. -
-

For more information, please see our contribution guide.

-

XrmEx is released as an open-source project. We welcome contributions from the developer community. Whether it's a bug report, new feature, or a correction, we greatly appreciate any help you can provide.

-

Leverage the power of Dynamics 365 Client API with less code and fewer errors. Get started with XrmEx today!

-

Why Use the XrmEx Library?

When developing for Dynamics 365, efficiency, clarity, and maintainability are paramount. The XrmEx library is designed to streamline your coding experience, making it more intuitive and less error-prone. Let's delve into some examples to illustrate the transformative power of XrmEx:

-

1. Event Handling

Without XrmEx:

formContext.data.entity.addOnSave(sample);
-
-

With XrmEx:

XrmEx.Form.addOnSaveEventHandler([sample]);
-
-

The XrmEx approach is more concise and offers a clearer intent, especially when registering multiple functions.

-

2. Field Changes and Events

Without XrmEx:

let firstname = formContext.getAttribute("firstname");
let lastname = formContext.getAttribute("lastname");
firstname.addOnChange(sample);
firstname.fireOnChange();
lastname.fireOnChange(); -
-

With XrmEx:

XrmEx.Form.addOnChangeEventHandler(
[fields.Firstname, fields.Lastname],
[sample],
true //fireOnChange
); -
-

With XrmEx, you can handle multiple fields and events in a single line, making the code cleaner and more maintainable.

-

3. Form Types and Field Requirements

Without XrmEx:

if (formContext.ui.getFormType() != 2) return;
let firstname = formContext.getAttribute("firstname");
if (!firstname.getValue()) {
firstname.setRequiredLevel("required");
firstname.controls.forEach((c) =>
c.setNotification("This property is required", "uniqueId")
);
} -
-

With XrmEx:

if (XrmEx.Form.IsNotUpdate) return;
if (!fields.Firstname.Value)
fields.Firstname.setRequired(true).setNotification(
"This property is required","uniqueId"); -
-

XrmEx provides intuitive methods that simplify common tasks, like checking form types or setting field requirements. You don't have to use the redundant forEach anymore.

-

4. Data Retrieval and Setting

Without XrmEx:

let ownerid = formContext.getAttribute("ownerid");
let lastname = formContext.getAttribute("lastname");
if (ownerid.getValue() && !lastname.getValue()) {
let user = await Xrm.WebApi.retrieveRecord(
ownerid.getValue()[0].entityType,
ownerid.getValue()[0].id,
"?$select=lastname"
);
lastname.setValue(user.lastname);
} -
-

With XrmEx:

if (fields.Owner.Value && !fields.Lastname.Value) {
let user = await fields.Owner.retrieve("?$select=lastname");//Returns null if empty
fields.Lastname.Value = user.lastname;
fields.Lastname.setValue(user.lastname);
} -
-

XrmEx abstracts away the complexities of data retrieval, making it more straightforward and readable.

-

5. Alert Dialogs in Dynamics 365

Without XrmEx:

await Xrm.Navigation.openAlertDialog({ text: `Error in ${XrmEx.getFunctionName()}\n` + error.message, title: "Error" }, { height: 120, width: 260 });
-
-

This method requires manual sizing and is more verbose, making it less efficient for dynamic content.

-

With XrmEx:

await XrmEx.openAlertDialog("Error", `Error in ${XrmEx.getFunctionName()}\n` + error.message);
-
-

The XrmEx approach automatically sizes the dialog based on content to avoid scrolling, offering a simplified and concise method.

-

Advanced Features

1. Lookup Filters

Without XrmEx:

let filterFunction = function filterFunction(executionContext) {
let formContext = executionContext.getFormContext();
let customer = formContext.getAttribute("parentcustomerid");
customer.controls.forEach((c) => {
c.addCustomFilter(
`<filter>
<condition attribute="lastname" operator="like" value="%Test%" />
</filter>`
);
});
};
let customer = formContext.getAttribute("parentcustomerid");
customer.controls.forEach((c) => c.addPreSearch(filterFunction));
customer.controls.forEach((c) => c.removePreSearch(filterFunction)); -
-

With XrmEx:

fields.Customer.addPreFilterToLookup(
`<filter>
<condition attribute="lastname" operator="like" value="%Test%" />
</filter>`
);
fields.Customer.clearPreFilterFromLookup(); //Removes all filter added with addPreFilterToLookup or addPreFilterToLookupAdvanced -
-

2. Advanced Lookup Filter

Special with XrmEx: Supports entire FetchXml including Link-Entity!

await fields.Customer.addPreFilterToLookupAdvanced(
"contact",//entityname
"contactid",//entity unique identifier name
`<fetch>
<entity name="contact">
<filter>
<condition attribute="lastname" operator="like" value="%Test%" />
</filter>
<link-entity name="account" from="accountid" to="parentcustomerid">
<filter>
<condition attribute="address1_country" operator="eq" value="Switzerland" />
</filter>
</link-entity>
</entity>
</fetch>`
); -
-

3. Execute Bound Action

Without XrmEx:

class TestActionContactRequest {
Amount: 0;
Account: null;
getMetadata() {
return {
boundParameter: "entity",
operationType: 0,
operationName: "theia_TestActionContact",
parameterTypes: {
Amount: {
typeName: "Edm.Int32",
structuralProperty: 1,
},
Account: {
typeName: "mscrm.account",
structuralProperty: 5,
},
entity: {
typeName: "mscrm.contact",
structuralProperty: 5,
},
},
};
}
}
let testActionContactRequest = new TestActionContactRequest();
testActionContactRequest.Amount = 5;
testActionContactRequest.Account = customer.getValue()[0];
testActionContactRequest["entity"] =
formContext.data.entity.getEntityReference();
let response = await Xrm.WebApi.online.execute(testActionContactRequest)
.then(function (response) {
if (response.ok) {
return response.json().catch(() => {
return response;
});
}
})
.then((responseBody) => responseBody);
console.log(response); -
-

With XrmEx:

let response2 = await XrmEx.executeAction(
"theia_TestActionContact",
[
{ Name: "Amount", Type: "Integer", Value: 5 },
{
Name: "Account",
Type: "EntityReference",
Value: fields.Customer.Value[0],
},
],
XrmEx.Form.entityReference
);
console.log(response2); -
-

4. Retrieve EnvironmentVariableValue

Without XrmEx:

class EnvironmentVariableRequest {
DefinitionSchemaName: "";
constructor(definitionSchemaName) {
this.DefinitionSchemaName = definitionSchemaName;
}
getMetadata() {
return {
boundParameter: null,
operationType: 1,
operationName: "RetrieveEnvironmentVariableValue",
parameterTypes: {
DefinitionSchemaName: {
typeName: "Edm.String",
structuralProperty: 1,
},
},
};
}
}
let environmentVariableRequest = new EnvironmentVariableRequest("theia_Test");
let value = await Xrm.WebApi.online.execute(environmentVariableRequest)
.then(function (response) {
if (response.ok) {
return response.json().catch(() => {
return response;
});
}
})
.then((responseBody) => responseBody);
console.log(value); -
-

With XrmEx:

let value2 = await XrmEx.getEnvironmentVariableValue("theia_Test");
console.log(value2); -
-

In Conclusion: The advanced features of the XrmEx library further exemplify its power in simplifying and enhancing the Dynamics 365 development experience. By abstracting away the complexities, developers can focus on the core logic and functionality of their applications.

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Window.html b/docs/interfaces/node_modules__types_xrm.Window.html deleted file mode 100644 index 57fab84..0000000 --- a/docs/interfaces/node_modules__types_xrm.Window.html +++ /dev/null @@ -1,4696 +0,0 @@ -Window | xrm-ex
-
- -
-
-
-
- -

Interface Window

-
-

A window containing a DOM document; the document property points to the DOM document loaded in that window.

-

MDN Reference

-
-
-
-

Hierarchy

-
    -
  • EventTarget
  • -
  • AnimationFrameProvider
  • -
  • GlobalEventHandlers
  • -
  • WindowEventHandlers
  • -
  • WindowLocalStorage
  • -
  • WindowOrWorkerGlobalScope
  • -
  • WindowSessionStorage -
      -
    • Window
-
-

Indexable

-
[index: number]: Window
-
-
-
- -
-
-

Properties

-
Xrm -caches -clientInformation -closed -crossOriginIsolated -crypto -customElements -devicePixelRatio -document -event -external -frameElement -frames -history -indexedDB -innerHeight -innerWidth -isSecureContext -length -localStorage -locationbar -menubar -name -navigator -onabort -onafterprint -onanimationcancel -onanimationend -onanimationiteration -onanimationstart -onauxclick -onbeforeinput -onbeforeprint -onbeforeunload -onblur -oncancel -oncanplay -oncanplaythrough -onchange -onclick -onclose -oncontextmenu -oncopy -oncuechange -oncut -ondblclick -ondevicemotion -ondeviceorientation -ondrag -ondragend -ondragenter -ondragleave -ondragover -ondragstart -ondrop -ondurationchange -onemptied -onended -onerror -onfocus -onformdata -ongamepadconnected -ongamepaddisconnected -ongotpointercapture -onhashchange -oninput -oninvalid -onkeydown -onkeypress -onkeyup -onlanguagechange -onload -onloadeddata -onloadedmetadata -onloadstart -onlostpointercapture -onmessage -onmessageerror -onmousedown -onmouseenter -onmouseleave -onmousemove -onmouseout -onmouseover -onmouseup -onoffline -ononline -onorientationchange -onpagehide -onpageshow -onpaste -onpause -onplay -onplaying -onpointercancel -onpointerdown -onpointerenter -onpointerleave -onpointermove -onpointerout -onpointerover -onpointerup -onpopstate -onprogress -onratechange -onrejectionhandled -onreset -onresize -onscroll -onsecuritypolicyviolation -onseeked -onseeking -onselect -onselectionchange -onselectstart -onslotchange -onstalled -onstorage -onsubmit -onsuspend -ontimeupdate -ontoggle -ontouchcancel? -ontouchend? -ontouchmove? -ontouchstart? -ontransitioncancel -ontransitionend -ontransitionrun -ontransitionstart -onunhandledrejection -onunload -onvolumechange -onwaiting -onwebkitanimationend -onwebkitanimationiteration -onwebkitanimationstart -onwebkittransitionend -onwheel -opener -orientation -origin -outerHeight -outerWidth -pageXOffset -pageYOffset -parent -performance -personalbar -screen -screenLeft -screenTop -screenX -screenY -scrollX -scrollY -scrollbars -self -sessionStorage -speechSynthesis -status -statusbar -toolbar -top -visualViewport -window -
-
-

Accessors

-
-
-

Methods

-
-
-

Properties

-
- -
-
- -
caches: CacheStorage
-

Available only in secure contexts.

-

MDN Reference

-
-
-
- -
clientInformation: Navigator
-
-

Deprecated

This is a legacy alias of navigator.

-

MDN Reference

-
-
- -
closed: boolean
-

Returns true if the window has been closed, false otherwise.

-

MDN Reference

-
-
-
- -
crossOriginIsolated: boolean
- -
-
- -
crypto: Crypto
- -
-
- -
customElements: CustomElementRegistry
-

Defines a new custom element, mapping the given name to the given constructor as an autonomous custom element.

-

MDN Reference

-
-
-
- -
devicePixelRatio: number
- -
-
- -
document: Document
- -
-
- -
event: Event
-
-

Deprecated

MDN Reference

-
-
- -
external: External
-
-

Deprecated

MDN Reference

-
-
- -
frameElement: Element
- -
-
- -
frames: Window
- -
-
- -
history: History
- -
-
- -
indexedDB: IDBFactory
- -
-
- -
innerHeight: number
- -
-
- -
innerWidth: number
- -
-
- -
isSecureContext: boolean
- -
-
- -
length: number
- -
-
- -
localStorage: Storage
- -
-
- -
locationbar: BarProp
-

Returns true if the location bar is visible; otherwise, returns false.

-

MDN Reference

-
-
-
- -
menubar: BarProp
-

Returns true if the menu bar is visible; otherwise, returns false.

-

MDN Reference

-
-
-
- -
name: string
- -
-
- -
navigator: Navigator
- -
-
- -
onabort: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user aborts the download.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: UIEvent
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onafterprint: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
onanimationcancel: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: AnimationEvent
      -

      Returns any

      -
-
- -
onanimationend: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: AnimationEvent
      -

      Returns any

      -
-
- -
onanimationiteration: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: AnimationEvent
      -

      Returns any

      -
-
- -
onanimationstart: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: AnimationEvent
      -

      Returns any

      -
-
- -
onauxclick: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
      -

      Returns any

      -
-
- -
onbeforeinput: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: InputEvent
      -

      Returns any

      -
-
- -
onbeforeprint: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
onbeforeunload: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: BeforeUnloadEvent
      -

      Returns any

      -
-
- -
onblur: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the object loses the input focus.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: FocusEvent
        -

        The focus event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
oncancel: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
oncanplay: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when playback is possible, but would require further buffering.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
oncanplaythrough: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
onchange: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the contents of the object or selection have changed.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onclick: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user clicks the left mouse button on the object

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
        -

        The mouse event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onclose: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
oncontextmenu: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user clicks the right mouse button in the client area, opening the context menu.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
        -

        The mouse event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
oncopy: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: ClipboardEvent
      -

      Returns any

      -
-
- -
oncuechange: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
oncut: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: ClipboardEvent
      -

      Returns any

      -
-
- -
ondblclick: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user double-clicks the object.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
        -

        The mouse event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
ondevicemotion: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Available only in secure contexts.

      -

      MDN Reference

      -
      -
      -

      Parameters

      -
        -
      • -
        this: Window
      • -
      • -
        ev: DeviceMotionEvent
      -

      Returns any

      -
-
- -
ondeviceorientation: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Available only in secure contexts.

      -

      MDN Reference

      -
      -
      -

      Parameters

      -
        -
      • -
        this: Window
      • -
      • -
        ev: DeviceOrientationEvent
      -

      Returns any

      -
-
- -
ondrag: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires on the source object continuously during a drag operation.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: DragEvent
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
ondragend: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires on the source object when the user releases the mouse at the close of a drag operation.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: DragEvent
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
ondragenter: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires on the target element when the user drags the object to a valid drop target.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: DragEvent
        -

        The drag event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
ondragleave: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: DragEvent
        -

        The drag event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
ondragover: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires on the target element continuously while the user drags the object over a valid drop target.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: DragEvent
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
ondragstart: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires on the source object when the user starts to drag a text selection or selected object.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: DragEvent
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
ondrop: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: DragEvent
      -

      Returns any

      -
-
- -
ondurationchange: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the duration attribute is updated.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onemptied: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the media element is reset to its initial state.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onended: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the end of playback is reached.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onerror: OnErrorEventHandlerNonNull
-

Fires when an error occurs during object loading.

-
-
-

Param

The event.

-

MDN Reference

-
-
- -
onfocus: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the object receives focus.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: FocusEvent
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onformdata: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: FormDataEvent
      -

      Returns any

      -
-
- -
ongamepadconnected: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: GamepadEvent
      -

      Returns any

      -
-
- -
ongamepaddisconnected: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: GamepadEvent
      -

      Returns any

      -
-
- -
ongotpointercapture: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: PointerEvent
      -

      Returns any

      -
-
- -
onhashchange: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: HashChangeEvent
      -

      Returns any

      -
-
- -
oninput: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
oninvalid: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
onkeydown: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user presses a key.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: KeyboardEvent
        -

        The keyboard event

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onkeypress: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user presses an alphanumeric key.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: KeyboardEvent
        -

        The event.

        -
        -
      -

      Returns any

      -
      -

      Deprecated

      MDN Reference

      -
-
- -
onkeyup: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user releases a key.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: KeyboardEvent
        -

        The keyboard event

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onlanguagechange: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
onload: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires immediately after the browser loads the object.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onloadeddata: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when media data is loaded at the current playback position.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onloadedmetadata: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the duration and dimensions of the media have been determined.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onloadstart: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when Internet Explorer begins looking for media data.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onlostpointercapture: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: PointerEvent
      -

      Returns any

      -
-
- -
onmessage: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: MessageEvent<any>
      -

      Returns any

      -
-
- -
onmessageerror: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: MessageEvent<any>
      -

      Returns any

      -
-
- -
onmousedown: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user clicks the object with either mouse button.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
        -

        The mouse event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onmouseenter: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
      -

      Returns any

      -
-
- -
onmouseleave: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
      -

      Returns any

      -
-
- -
onmousemove: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user moves the mouse over the object.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
        -

        The mouse event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onmouseout: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user moves the mouse pointer outside the boundaries of the object.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
        -

        The mouse event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onmouseover: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user moves the mouse pointer into the object.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
        -

        The mouse event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onmouseup: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user releases a mouse button while the mouse is over the object.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: MouseEvent
        -

        The mouse event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onoffline: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
ononline: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
onorientationchange: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -
      -

      Parameters

      -
      -

      Returns any

      -
      -

      Deprecated

      MDN Reference

      -
-
- -
onpagehide: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: PageTransitionEvent
      -

      Returns any

      -
-
- -
onpageshow: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: PageTransitionEvent
      -

      Returns any

      -
-
- -
onpaste: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: ClipboardEvent
      -

      Returns any

      -
-
- -
onpause: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when playback is paused.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onplay: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the play method is requested.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onplaying: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the audio or video has started playing.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onpointercancel: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: PointerEvent
      -

      Returns any

      -
-
- -
onpointerdown: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: PointerEvent
      -

      Returns any

      -
-
- -
onpointerenter: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: PointerEvent
      -

      Returns any

      -
-
- -
onpointerleave: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: PointerEvent
      -

      Returns any

      -
-
- -
onpointermove: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: PointerEvent
      -

      Returns any

      -
-
- -
onpointerout: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: PointerEvent
      -

      Returns any

      -
-
- -
onpointerover: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: PointerEvent
      -

      Returns any

      -
-
- -
onpointerup: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: PointerEvent
      -

      Returns any

      -
-
- -
onpopstate: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: PopStateEvent
      -

      Returns any

      -
-
- -
onprogress: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs to indicate progress while downloading media data.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: ProgressEvent<EventTarget>
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onratechange: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the playback rate is increased or decreased.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onrejectionhandled: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: PromiseRejectionEvent
      -

      Returns any

      -
-
- -
onreset: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user resets a form.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onresize: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: UIEvent
      -

      Returns any

      -
-
- -
onscroll: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the user repositions the scroll box in the scroll bar on the object.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onsecuritypolicyviolation: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: SecurityPolicyViolationEvent
      -

      Returns any

      -
-
- -
onseeked: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the seek operation ends.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onseeking: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the current playback position is moved.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onselect: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Fires when the current selection changes.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onselectionchange: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
onselectstart: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
onslotchange: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
onstalled: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the download has stopped.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onstorage: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: StorageEvent
      -

      Returns any

      -
-
- -
onsubmit: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: SubmitEvent
      -

      Returns any

      -
-
- -
onsuspend: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs if the load operation has been intentionally halted.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
ontimeupdate: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs to indicate the current playback position.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
ontoggle: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
ontouchcancel?: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: TouchEvent
      -

      Returns any

      -
-
- -
ontouchend?: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: TouchEvent
      -

      Returns any

      -
-
- -
ontouchmove?: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: TouchEvent
      -

      Returns any

      -
-
- -
ontouchstart?: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: TouchEvent
      -

      Returns any

      -
-
- -
ontransitioncancel: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: TransitionEvent
      -

      Returns any

      -
-
- -
ontransitionend: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: TransitionEvent
      -

      Returns any

      -
-
- -
ontransitionrun: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: TransitionEvent
      -

      Returns any

      -
-
- -
ontransitionstart: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: TransitionEvent
      -

      Returns any

      -
-
- -
onunhandledrejection: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: PromiseRejectionEvent
      -

      Returns any

      -
-
- -
onunload: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: WindowEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
-
- -
onvolumechange: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when the volume is changed, or playback is muted or unmuted.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onwaiting: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -

      Occurs when playback stops because the next frame of a video resource is not available.

      -
      -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
        -

        The event.

        -

        MDN Reference

        -
        -
      -

      Returns any

      -
-
- -
onwebkitanimationend: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
      -

      Deprecated

      This is a legacy alias of onanimationend.

      -

      MDN Reference

      -
-
- -
onwebkitanimationiteration: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
      -

      Deprecated

      This is a legacy alias of onanimationiteration.

      -

      MDN Reference

      -
-
- -
onwebkitanimationstart: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
      -

      Deprecated

      This is a legacy alias of onanimationstart.

      -

      MDN Reference

      -
-
- -
onwebkittransitionend: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: Event
      -

      Returns any

      -
      -

      Deprecated

      This is a legacy alias of ontransitionend.

      -

      MDN Reference

      -
-
- -
onwheel: ((this, ev) => any)
-
-

Type declaration

-
    -
  • -
      -
    • (this, ev): any
    • -
    • - -
      -

      Parameters

      -
        -
      • -
        this: GlobalEventHandlers
      • -
      • -
        ev: WheelEvent
      -

      Returns any

      -
-
- -
opener: any
- -
-
- -
orientation: number
-
-

Deprecated

MDN Reference

-
-
- -
origin: string
- -
-
- -
outerHeight: number
- -
-
- -
outerWidth: number
- -
-
- -
pageXOffset: number
-
-

Deprecated

This is a legacy alias of scrollX.

-

MDN Reference

-
-
- -
pageYOffset: number
-
-

Deprecated

This is a legacy alias of scrollY.

-

MDN Reference

-
-
- -
parent: Window
-

Refers to either the parent WindowProxy, or itself.

-

It can rarely be null e.g. for contentWindow of an iframe that is already removed from the parent.

-

MDN Reference

-
-
-
- -
performance: Performance
- -
-
- -
personalbar: BarProp
-

Returns true if the personal bar is visible; otherwise, returns false.

-

MDN Reference

-
-
-
- -
screen: Screen
- -
-
- -
screenLeft: number
- -
-
- -
screenTop: number
- -
-
- -
screenX: number
- -
-
- -
screenY: number
- -
-
- -
scrollX: number
- -
-
- -
scrollY: number
- -
-
- -
scrollbars: BarProp
-

Returns true if the scrollbars are visible; otherwise, returns false.

-

MDN Reference

-
-
-
- -
self: Window & typeof globalThis
- -
-
- -
sessionStorage: Storage
- -
-
- -
speechSynthesis: SpeechSynthesis
- -
-
- -
status: string
-
-

Deprecated

MDN Reference

-
-
- -
statusbar: BarProp
-

Returns true if the status bar is visible; otherwise, returns false.

-

MDN Reference

-
-
-
- -
toolbar: BarProp
-

Returns true if the toolbar is visible; otherwise, returns false.

-

MDN Reference

-
-
-
- -
top: Window
- -
-
- -
visualViewport: VisualViewport
- -
-
- -
window: Window & typeof globalThis
- -
-
-

Accessors

-
- -
    -
  • get location(): Location
  • -
  • - -

    Returns Location

    -
  • -
  • set location(href): void
  • -
  • -
    -

    Parameters

    -
      -
    • -
      href: string | Location
    -

    Returns void

-
-

Methods

-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      K extends keyof WindowEventMap

    -
    -

    Parameters

    -
      -
    • -
      type: K
    • -
    • -
      listener: ((this, ev) => any)
      -
        -
      • -
          -
        • (this, ev): any
        • -
        • -
          -

          Parameters

          -
            -
          • -
            this: Window
          • -
          • -
            ev: WindowEventMap[K]
          -

          Returns any

    • -
    • -
      Optional options: boolean | AddEventListenerOptions
    -

    Returns void

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      type: string
    • -
    • -
      listener: EventListenerOrEventListenerObject
    • -
    • -
      Optional options: boolean | AddEventListenerOptions
    -

    Returns void

-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      Optional message: any
    -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      data: string
    -

    Returns string

    -
-
- -
    - -
  • - -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      data: string
    -

    Returns string

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      handle: number
    -

    Returns void

-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      handle: number
    -

    Returns void

    -
-
- -
    - -
  • -

    Returns void

    -
    -

    Deprecated

    MDN Reference

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      id: number
    -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      id: number
    -

    Returns void

    -
-
- -
    - -
  • -

    Closes the window.

    -

    MDN Reference

    -
    -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      Optional message: string
    -

    Returns boolean

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      image: ImageBitmapSource
    • -
    • -
      Optional options: ImageBitmapOptions
    -

    Returns Promise<ImageBitmap>

    -
  • - -
  • -
    -

    Parameters

    -
      -
    • -
      image: ImageBitmapSource
    • -
    • -
      sx: number
    • -
    • -
      sy: number
    • -
    • -
      sw: number
    • -
    • -
      sh: number
    • -
    • -
      Optional options: ImageBitmapOptions
    -

    Returns Promise<ImageBitmap>

-
- -
    - -
  • -

    Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    -

    MDN Reference

    -
    -
    -

    Parameters

    -
      -
    • -
      event: Event
    -

    Returns boolean

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      input: URL | RequestInfo
    • -
    • -
      Optional init: RequestInit
    -

    Returns Promise<Response>

    -
-
- -
    - -
  • -

    Moves the focus to the window's browsing context, if any.

    -

    MDN Reference

    -
    -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      elt: Element
    • -
    • -
      Optional pseudoElt: string
    -

    Returns CSSStyleDeclaration

    -
-
- -
    - -
  • - -

    Returns Selection

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      query: string
    -

    Returns MediaQueryList

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      x: number
    • -
    • -
      y: number
    -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      x: number
    • -
    • -
      y: number
    -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      Optional url: string | URL
    • -
    • -
      Optional target: string
    • -
    • -
      Optional features: string
    -

    Returns Window

    -
-
- -
    - -
  • -

    Posts a message to the given window. Messages can be structured objects, e.g. nested objects and arrays, can contain JavaScript values (strings, numbers, Date objects, etc), and can contain certain data objects such as File Blob, FileList, and ArrayBuffer objects.

    -

    Objects listed in the transfer member of options are transferred, not just cloned, meaning that they are no longer usable on the sending side.

    -

    A target origin can be specified using the targetOrigin member of options. If not provided, it defaults to "/". This default restricts the message to same-origin targets only.

    -

    If the origin of the target window doesn't match the given target origin, the message is discarded, to avoid information leakage. To send the message to the target regardless of origin, set the target origin to "*".

    -

    Throws a "DataCloneError" DOMException if transfer array contains duplicate objects or if message could not be cloned.

    -

    MDN Reference

    -
    -
    -

    Parameters

    -
      -
    • -
      message: any
    • -
    • -
      targetOrigin: string
    • -
    • -
      Optional transfer: Transferable[]
    -

    Returns void

    -
  • - -
  • -
    -

    Parameters

    -
      -
    • -
      message: any
    • -
    • -
      Optional options: WindowPostMessageOptions
    -

    Returns void

-
- -
    - -
  • - -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      Optional message: string
    • -
    • -
      Optional _default: string
    -

    Returns string

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      callback: VoidFunction
    -

    Returns void

    -
-
- -
    - -
  • -

    Returns void

    -
    -

    Deprecated

    MDN Reference

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      K extends keyof WindowEventMap

    -
    -

    Parameters

    -
      -
    • -
      type: K
    • -
    • -
      listener: ((this, ev) => any)
      -
        -
      • -
          -
        • (this, ev): any
        • -
        • -
          -

          Parameters

          -
            -
          • -
            this: Window
          • -
          • -
            ev: WindowEventMap[K]
          -

          Returns any

    • -
    • -
      Optional options: boolean | EventListenerOptions
    -

    Returns void

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      type: string
    • -
    • -
      listener: EventListenerOrEventListenerObject
    • -
    • -
      Optional options: boolean | EventListenerOptions
    -

    Returns void

-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      e: any
    -

    Returns void

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      callback: FrameRequestCallback
    -

    Returns number

-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      callback: IdleRequestCallback
    • -
    • -
      Optional options: IdleRequestOptions
    -

    Returns number

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      x: number
    • -
    • -
      y: number
    -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      width: number
    • -
    • -
      height: number
    -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      Optional options: ScrollToOptions
    -

    Returns void

    -
  • - -
  • -
    -

    Parameters

    -
      -
    • -
      x: number
    • -
    • -
      y: number
    -

    Returns void

-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      Optional options: ScrollToOptions
    -

    Returns void

    -
  • - -
  • -
    -

    Parameters

    -
      -
    • -
      x: number
    • -
    • -
      y: number
    -

    Returns void

-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      Optional options: ScrollToOptions
    -

    Returns void

    -
  • - -
  • -
    -

    Parameters

    -
      -
    • -
      x: number
    • -
    • -
      y: number
    -

    Returns void

-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      handler: TimerHandler
    • -
    • -
      Optional timeout: number
    • -
    • -
      Rest ...arguments: any[]
    -

    Returns number

    -
-
- -
    - -
  • - -
    -

    Parameters

    -
      -
    • -
      handler: TimerHandler
    • -
    • -
      Optional timeout: number
    • -
    • -
      Rest ...arguments: any[]
    -

    Returns number

    -
-
- -
    - -
  • -

    Cancels the document load.

    -

    MDN Reference

    -
    -

    Returns void

    -
-
- -
    - -
  • - -
    -

    Type Parameters

    -
      -
    • -

      T = any

    -
    -

    Parameters

    -
      -
    • -
      value: T
    • -
    • -
      Optional options: StructuredSerializeOptions
    -

    Returns T

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.App-1.html b/docs/interfaces/node_modules__types_xrm.Xrm.App-1.html deleted file mode 100644 index 7975cb9..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.App-1.html +++ /dev/null @@ -1,267 +0,0 @@ -App | xrm-ex
-
- -
-
-
-
- -

Interface App

-
-

Interface for Xrm.App API

-
-
-
-

Hierarchy

-
    -
  • App
-
-
-
- -
-
-

Properties

-
- -
sidePanes: {
    state: number;
    createPane(paneOptions?) => PromiseLike<PaneObject>;
    getAllPanes() => PaneObject[];
    getPane(panelId) => PaneObject;
    getSelectedPane() => PaneObject;
}
-

Provides methods for managing side panes.

-
-
-

Type declaration

-
    -
  • -
    state: number
    -
    -

    Returns

    whether the selected pane is collapsed or expanded.

    -
  • -
  • -
    createPane:function
    -
      - -
    • -

      Provides all the information to create side panes.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional paneOptions: PaneOptions
        -

        The ID to use to clear a specific notification that was set using addGlobalNotification.

        -
        -
      -

      Returns PromiseLike<PaneObject>

      -
  • -
  • -
    getAllPanes:function
    -
      - -
    • -

      Returns PaneObject[]

      a collection containing all active panes.

      - -
  • -
  • -
    getPane:function
    -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        panelId: string
        -

        string

        -
        -
      -

      Returns PaneObject

      the side pane corresponding to the input ID. If the side pane does not exist, undefined is returned.

      - -
  • -
  • -
    getSelectedPane:function
    -
      - -
    • -

      Returns PaneObject

      the currently selected pane.

      - -
-
-
-

Methods

-
- -
    - -
  • -

    Displays an error, information, warning, or success notification for an app, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
      -
    • -
      notification: Notification
      -

      The notification to add.

      -
      -
    -

    Returns PromiseLike<string>

    On success, returns a promise object containing a GUID value to uniquely identify the notification as described earlier in the description of the successCallback parameter.

    - -
-
- -
    - -
  • -

    Clears a notification in the app.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      The ID to use to clear a specific notification that was set using addGlobalNotification.

      -
      -
    -

    Returns PromiseLike<string>

    On success, returns a promise object.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.App.Action.html b/docs/interfaces/node_modules__types_xrm.Xrm.App.Action.html deleted file mode 100644 index ebb7c86..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.App.Action.html +++ /dev/null @@ -1,176 +0,0 @@ -Action | xrm-ex
-
- -
-
-
-
- -

Interface Action

-
-

Defines the action of notification

-
-
-

See

Xmr.App.Notification

-
-
-

Hierarchy

-
    -
  • Action
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
actionLabel?: string
-

The label for the action in the message.

-
-
-
- -
eventHandler?: (() => void)
-
-

Type declaration

-
    -
  • -
      -
    • (): void
    • -
    • -

      The function to execute when the action label is clicked.

      -
      -

      Returns void

      -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.App.Notification.html b/docs/interfaces/node_modules__types_xrm.Xrm.App.Notification.html deleted file mode 100644 index 6aa0a18..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.App.Notification.html +++ /dev/null @@ -1,198 +0,0 @@ -Notification | xrm-ex
-
- -
-
-
-
- -

Interface Notification

-
-

Defines the notification object for Xrm.App.addGlobalNotification

-
-
-

See

Xmr.App.addGlobalNotification

-
-
-

Hierarchy

-
    -
  • Notification
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
action?: Action
-
-

See

Action

-
-
- - -

Defines the level of notification.

-
-
-
- -
message: string
-

The message to display in the notification.

-
-
-
- -
showCloseButton?: boolean
-

Indicates whether or not the user can close or dismiss the notification. If you don't specify this parameter, users can't close or dismiss the notification by default.

-
-
-
- -
type: number
-

Defines the type of notification. Currently, only a value of 2 is supported, which displays a message bar at the top of the app.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.App.PaneObject.html b/docs/interfaces/node_modules__types_xrm.Xrm.App.PaneObject.html deleted file mode 100644 index 35fafcf..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.App.PaneObject.html +++ /dev/null @@ -1,287 +0,0 @@ -PaneObject | xrm-ex
-
- -
-
-
-
- -

Interface PaneObject

-
-

Defines methods single side pane.

-
-
-
-

Hierarchy

-
    -
  • Omit<PaneOptions, "isSelected" | "hideHeader"> -
      -
    • PaneObject
-
-
-
- -
-
-

Properties

-
- -
alwaysRender?: boolean
-

Prevents the pane from unmounting when it is hidden.

-
-
-
- -
canClose?: boolean
-

Whether the pane header will show a close button or not.

-
-
-
- -
hidden?: boolean
-

Hides the pane and tab.

-
-
-
- -
imageSrc?: string
-

The path of the icon to show in the panel switcher control.

-
-
-
- -
keepBadgeOnSelect?: boolean
-

Prevents the badge from getting cleared when the pane becomes selected.

-
-
-
- -
paneId?: string
-

The ID of the new pane. If the value is not passed, the ID value is auto-generated.

-
-
-
- -
title?: string
-

The title of the pane. Used in pane header and for tooltip.

-
-
-
- -
width?: number
-

The width of the pane in pixels.

-
-
-
-

Methods

-
- -
    - -
  • -

    Closes the side pane and removes it from the side bar.

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Specify whether the pane should be selected or expanded.

    -
    -

    Returns void

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.App.PaneOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.App.PaneOptions.html deleted file mode 100644 index 1c477a1..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.App.PaneOptions.html +++ /dev/null @@ -1,248 +0,0 @@ -PaneOptions | xrm-ex
-
- -
-
-
-
- -

Interface PaneOptions

-
-

Defines single side pane.

-
-
-

See

createPane

-
-
-

Hierarchy

-
    -
  • PaneOptions
-
-
-
- -
-
-

Properties

-
- -
alwaysRender?: boolean
-

Prevents the pane from unmounting when it is hidden.

-
-
-
- -
canClose?: boolean
-

Whether the pane header will show a close button or not.

-
-
-
- -
hidden?: boolean
-

Hides the pane and tab.

-
-
-
- -
hideHeader?: boolean
-

Hides the header pane, including the title and close button. Default value is false.

-
-
-
- -
imageSrc?: string
-

The path of the icon to show in the panel switcher control.

-
-
-
- -
isSelected?: boolean
-

When set to false, the created pane is not selected and leaves the existing pane selected. It also does not expand the pane if collapsed.

-
-
-
- -
keepBadgeOnSelect?: boolean
-

Prevents the badge from getting cleared when the pane becomes selected.

-
-
-
- -
paneId?: string
-

The ID of the new pane. If the value is not passed, the ID value is auto-generated.

-
-
-
- -
title?: string
-

The title of the pane. Used in pane header and for tooltip.

-
-
-
- -
width?: number
-

The width of the pane in pixels.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.AppProperties.html b/docs/interfaces/node_modules__types_xrm.Xrm.AppProperties.html deleted file mode 100644 index 2426ecf..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.AppProperties.html +++ /dev/null @@ -1,194 +0,0 @@ -AppProperties | xrm-ex
-
- -
-
-
-
- -

Interface AppProperties

-
-

properties of the current business app in Customer Engagement.

-
-
-
-

Hierarchy

-
    -
  • AppProperties
-
-
-
- -
-
-

Properties

-
- -
appId?: string
-
- -
displayName?: string
-
- -
uniqueName?: string
-
- -
url?: string
-
- -
webResourceId?: string
-
- -
webResourceName?: string
-
- -
welcomePageId?: string
-
- -
welcomePageName?: string
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Async.ErrorCallbackObject.html b/docs/interfaces/node_modules__types_xrm.Xrm.Async.ErrorCallbackObject.html deleted file mode 100644 index 72216d8..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Async.ErrorCallbackObject.html +++ /dev/null @@ -1,169 +0,0 @@ -ErrorCallbackObject | xrm-ex
-
- -
-
-
-
- -

Interface ErrorCallbackObject

-
-

Object passed to ErrorCallbackDelegate.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
errorCode: number
-

The error code.

-
-
-
- -
message: string
-

An error message describing the issue.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Async.OfflineErrorCallbackObject.html b/docs/interfaces/node_modules__types_xrm.Xrm.Async.OfflineErrorCallbackObject.html deleted file mode 100644 index c349e0e..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Async.OfflineErrorCallbackObject.html +++ /dev/null @@ -1,181 +0,0 @@ -OfflineErrorCallbackObject | xrm-ex
-
- -
-
-
-
- -

Interface OfflineErrorCallbackObject

-
-

Object passed to OfflineErrorCallbackDelegate.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
debugMessage: string
-

An internal error message that might contain additional details about the issue.

-
-
-
- -
errorCode: number
-

The error code.

-
-
-
- -
message: string
-

An error message describing the issue.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Async.OfflineOperationSuccessCallbackObject.html b/docs/interfaces/node_modules__types_xrm.Xrm.Async.OfflineOperationSuccessCallbackObject.html deleted file mode 100644 index b5b5eb2..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Async.OfflineOperationSuccessCallbackObject.html +++ /dev/null @@ -1,167 +0,0 @@ -OfflineOperationSuccessCallbackObject | xrm-ex
-
- -
-
-
-
- -

Interface OfflineOperationSuccessCallbackObject

-
-

Object passed to OfflineOperationSuccessCallbackDelegate;

-
-
-
-

Hierarchy

-
    -
  • OfflineOperationSuccessCallbackObject
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
id: string
-

GUID of the record;

-
-
-
- -
logicalName: string
-

Logical name of the entity.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Async.OpenQuickCreateSuccessCallbackObject.html b/docs/interfaces/node_modules__types_xrm.Xrm.Async.OpenQuickCreateSuccessCallbackObject.html deleted file mode 100644 index 1822103..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Async.OpenQuickCreateSuccessCallbackObject.html +++ /dev/null @@ -1,157 +0,0 @@ -OpenQuickCreateSuccessCallbackObject | xrm-ex
-
- -
-
-
-
- -

Interface OpenQuickCreateSuccessCallbackObject

-
-

Object passed to QuickCreateSuccessCallbackDelegate.

-
-
-
-

Hierarchy

-
    -
  • OpenQuickCreateSuccessCallbackObject
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
savedEntityReference: Xrm.LookupValue
-

A lookup value which identifies the record which has been created.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Async.PromiseLike.html b/docs/interfaces/node_modules__types_xrm.Xrm.Async.PromiseLike.html deleted file mode 100644 index ebeb909..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Async.PromiseLike.html +++ /dev/null @@ -1,365 +0,0 @@ -PromiseLike | xrm-ex
-
- -
-
-
-
- -

Interface PromiseLike<T>

-
-

Interface for asynchronous promises. Based on JQuery Promise

-
-
-
-

Type Parameters

-
    -
  • -

    T

-
-

Hierarchy

-
    -
  • PromiseLike
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    UNDOCUMENTED (Web Client only): Add handlers to be called when the Deferred object is either resolved or rejected.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns PromiseLike<U>

    -
-
- -
    - -
  • -

    UNDOCUMENTED (Unified Client only): Add handlers to be called when the Deferred object is rejected.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns PromiseLike<U>

    -
-
- -
    - -
  • -

    UNDOCUMENTED (Web Client only) Add handlers to be called when the Deferred object is rejected.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns PromiseLike<U>

    -
-
- -
    - -
  • -

    UNDOCUMENTED (Unified Client only): Add handlers to be called when the Deferred object is either resolved or rejected.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns PromiseLike<U>

    -
-
- -
    - -
  • -

    Attaches callbacks for the resolution and/or rejection of the Promise.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns PromiseLike<U>

    A Promise for the completion of which ever callback is executed.

    - -
  • - -
  • -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      Optional onFulfilled: ((value) => U | PromiseLike<U>)
      -
    • -
    • -
      Optional onRejected: ((error) => void)
      -
        -
      • -
          -
        • (error): void
        • -
        • -
          -

          Parameters

          -
            -
          • -
            error: any
          -

          Returns void

    -

    Returns PromiseLike<U>

-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.Attribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.Attribute.html deleted file mode 100644 index 591527d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.Attribute.html +++ /dev/null @@ -1,504 +0,0 @@ -Attribute | xrm-ex
-
- -
-
-
-
- -

Interface Attribute<T>

-
-

Interface for an Entity attribute.

-
-
-
-

Type Parameters

-
    -
  • -

    T = any

-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Gets attribute type.

    -
    -

    Returns Xrm.Attributes.AttributeType

    The attribute's type name.

    -Values returned are:

    -
      -
    • boolean
    • -
    • datetime
    • -
    • decimal
    • -
    • double
    • -
    • integer
    • -
    • lookup
    • -
    • memo
    • -
    • money
    • -
    • optionset
    • -
    • string
    • -
    - -
-
- -
    - -
  • -

    Gets the attribute format.

    -
    -

    Returns Xrm.Attributes.AttributeFormat

    The format of the attribute.

    -Values returned are:

    -
      -
    • date (datetime)
    • -
    • datetime (datetime)
    • -
    • duration (integer)
    • -
    • email (string)
    • -
    • language (optionset)
    • -
    • none (integer)
    • -
    • phone (string)
    • -
    • text (string)
    • -
    • textarea (string)
    • -
    • tickersymbol (string)
    • -
    • timezone (optionset)
    • -
    • url (string)
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
    - -
  • -

    Gets the current user's privileges for the attribute.

    -
    -

    Returns Xrm.Privilege

    The user privileges.

    - -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns T

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the required level.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.BooleanAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.BooleanAttribute.html deleted file mode 100644 index 741db33..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.BooleanAttribute.html +++ /dev/null @@ -1,521 +0,0 @@ -BooleanAttribute | xrm-ex
-
- -
-
-
-
- -

Interface BooleanAttribute

-
-

Interface for a Boolean attribute.

-
-
-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Gets the attribute format.

    -
    -

    Returns "boolean"

    the string "boolean"

    - -
-
- -
    - -
  • -

    Gets the attribute format.

    -
    -

    Returns Xrm.Attributes.AttributeFormat

    The format of the attribute.

    -Values returned are:

    -
      -
    • date (datetime)
    • -
    • datetime (datetime)
    • -
    • duration (integer)
    • -
    • email (string)
    • -
    • language (optionset)
    • -
    • none (integer)
    • -
    • phone (string)
    • -
    • text (string)
    • -
    • textarea (string)
    • -
    • tickersymbol (string)
    • -
    • timezone (optionset)
    • -
    • url (string)
    • -
    - -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns boolean

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: boolean
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.DateAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.DateAttribute.html deleted file mode 100644 index 7357f32..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.DateAttribute.html +++ /dev/null @@ -1,499 +0,0 @@ -DateAttribute | xrm-ex
-
- -
-
-
-
- -

Interface DateAttribute

-
-

Interface for a Date attribute.

-
-
-

See

Attribute

-
-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns Date

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: Date
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.EnumAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.EnumAttribute.html deleted file mode 100644 index c44651a..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.EnumAttribute.html +++ /dev/null @@ -1,537 +0,0 @@ -EnumAttribute | xrm-ex
-
- -
-
-
-
- -

Interface EnumAttribute<T>

-
-

Common interface for enumeration attributes (MultiOptionSet, OptionSet and Boolean).

-
-
-

See

Attribute

-
-
-

Type Parameters

-
    -
  • -

    T extends number[] | number | boolean

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Gets the attribute format.

    -
    -

    Returns Xrm.Attributes.AttributeFormat

    The format of the attribute.

    -Values returned are:

    -
      -
    • date (datetime)
    • -
    • datetime (datetime)
    • -
    • duration (integer)
    • -
    • email (string)
    • -
    • language (optionset)
    • -
    • none (integer)
    • -
    • phone (string)
    • -
    • text (string)
    • -
    • textarea (string)
    • -
    • tickersymbol (string)
    • -
    • timezone (optionset)
    • -
    • url (string)
    • -
    - -
-
- -
    - -
  • -

    Gets the initial value of the attribute.

    -
    -

    Returns T

    The initial value.

    - -
    -

    Remarks

    Valid for OptionSet and boolean attribute types

    - -

    See

    External Link: getInitialValue (Client API reference)

    -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns T

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.LookupAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.LookupAttribute.html deleted file mode 100644 index 8b38ab4..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.LookupAttribute.html +++ /dev/null @@ -1,529 +0,0 @@ -LookupAttribute | xrm-ex
-
- -
-
-
-
- -

Interface LookupAttribute

-
-

Interface a Lookup attribute.

-
-
-

See

Attribute

-
-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Gets the attribute format.

    -
    -

    Returns Xrm.Attributes.AttributeFormat

    The format of the attribute.

    -Values returned are:

    -
      -
    • date (datetime)
    • -
    • datetime (datetime)
    • -
    • duration (integer)
    • -
    • email (string)
    • -
    • language (optionset)
    • -
    • none (integer)
    • -
    • phone (string)
    • -
    • text (string)
    • -
    • textarea (string)
    • -
    • tickersymbol (string)
    • -
    • timezone (optionset)
    • -
    • url (string)
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets a boolean value indicating whether the Lookup is a multi-value PartyList.

    -
    -

    Returns boolean

    true the attribute is a PartyList, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.MultiSelectOptionSetAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.MultiSelectOptionSetAttribute.html deleted file mode 100644 index edb9ebe..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.MultiSelectOptionSetAttribute.html +++ /dev/null @@ -1,600 +0,0 @@ -MultiSelectOptionSetAttribute | xrm-ex
-
- -
-
-
-
- -

Interface MultiSelectOptionSetAttribute

-
-

Interface an OptionSet attribute.

-
-
-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets the option matching a value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number
      -

      The enumeration value of the option desired.

      -
      -
    -

    Returns Xrm.OptionSetValue

    The option.

    - -
  • - -
  • -

    Gets the option matching a label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label of the option desired.

      -
      -
    -

    Returns Xrm.OptionSetValue

    The option.

    - -
-
- -
    - -
  • -

    Gets all of the options.

    -
    -

    Returns Xrm.OptionSetValue[]

    An array of options.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets selected option.

    -
    -

    Returns Xrm.OptionSetValue[]

    The selected option.

    - -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
    - -
  • -

    Gets the label of the currently selected option.

    -
    -

    Returns string[]

    The current value's label.

    - -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns number[]

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number[]
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    The getOptions() method returns option values as strings. You must use parseInt - to convert them to numbers before you can use those values to set the value of an - OptionSet attribute. Attributes on Quick Create Forms will not save values set - with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.NumberAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.NumberAttribute.html deleted file mode 100644 index fa26c5d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.NumberAttribute.html +++ /dev/null @@ -1,564 +0,0 @@ -NumberAttribute | xrm-ex
-
- -
-
-
-
- -

Interface NumberAttribute

-
-

Interface for a Number attribute.

-
-
-

See

Attribute

-
-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the maximum value allowed.

    -
    -

    Returns number

    The maximum value allowed.

    - -
-
- -
    - -
  • -

    Gets the minimum value allowed.

    -
    -

    Returns number

    The minimum value allowed.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
    - -
  • -

    Gets the attribute's configured precision.

    -
    -

    Returns number

    The total number of allowed decimal places.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns number

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the number of digits allowed to the right of the decimal point.

    -
    -
    -

    Parameters

    -
      -
    • -
      precision: number
      -

      Number of digits allowed to the right of the decimal point.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.OptionSetAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.OptionSetAttribute.html deleted file mode 100644 index 0db5f58..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.OptionSetAttribute.html +++ /dev/null @@ -1,607 +0,0 @@ -OptionSetAttribute | xrm-ex
-
- -
-
-
-
- -

Interface OptionSetAttribute<T>

-
-

Interface an OptionSet attribute.

-
-
-
-

Type Parameters

-
    -
  • -

    T extends number = number

-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets the option matching a value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number
      -

      The enumeration value of the option desired.

      -
      -
    -

    Returns Xrm.OptionSetValue

    The option.

    - -
  • - -
  • -

    Gets the option matching a label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label of the option desired.

      -
      -
    -

    Returns Xrm.OptionSetValue

    The option.

    - -
-
- -
    - -
  • -

    Gets all of the options.

    -
    -

    Returns Xrm.OptionSetValue[]

    An array of options.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets selected option.

    -
    -

    Returns Xrm.OptionSetValue

    The selected option.

    - -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
    - -
  • -

    Gets the label of the currently selected option.

    -
    -

    Returns string

    The current value's label.

    - -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns T

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    The getOptions() method returns option values as strings. You must use parseInt - to convert them to numbers before you can use those values to set the value of an - OptionSet attribute. Attributes on Quick Create Forms will not save values set - with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.StringAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.StringAttribute.html deleted file mode 100644 index c936c4c..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Attributes.StringAttribute.html +++ /dev/null @@ -1,517 +0,0 @@ -StringAttribute | xrm-ex
-
- -
-
-
-
- -

Interface StringAttribute

-
-

Interface for a String attribute.

-
-
-

See

Attribute

-
-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets maximum length allowed.

    -
    -

    Returns number

    The maximum length allowed.

    - -
    -

    Remarks

    The email form's "Description" attribute does not have the this method.

    -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns string

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: string
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    A String field with the email format enforces email - address formatting. Attributes on Quick Create Forms will not save values set - with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Calendar.html b/docs/interfaces/node_modules__types_xrm.Xrm.Calendar.html deleted file mode 100644 index 50d84a8..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Calendar.html +++ /dev/null @@ -1,187 +0,0 @@ -Calendar | xrm-ex
-
- -
-
-
-
- -

Interface Calendar

-
-

Interface for the DateFormattingInfo.calendar field

-
-
-
-

Hierarchy

-
    -
  • Calendar
-
-
-
- -
-
-

Properties

-
- -
AlgorithmType: number
-
- -
CalendarType: number
-
- -
Eras: number[]
-
- -
IsReadOnly: boolean
-
- -
MaxSupportedDateTime: Date
-
- -
MinSupportedDateTime: Date
-
- -
TwoDigitYearMax: number
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.ClientContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.ClientContext.html deleted file mode 100644 index 87159e0..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.ClientContext.html +++ /dev/null @@ -1,205 +0,0 @@ -ClientContext | xrm-ex
-
- -
-
-
-
- -

Interface ClientContext

-
-

Interface for the client context.

-
-
-
-

Hierarchy

-
    -
  • ClientContext
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns a value to indicate which client the script is executing in.

    -
    -

    Returns Xrm.Client

    The client, as either "Web", "Outlook", or "Mobile"

    - -
-
- -
    - -
  • -

    Gets client's current state.

    -
    -

    Returns Xrm.ClientState

    The client state, as either "Online" or "Offline"

    - -
-
- -
    - -
  • -

    Use this method to get information about the kind of device the user is using.

    -
    -

    Returns ClientFormFactor

    -
-
- -
    - -
  • -

    Returns information whether the network is available or not.

    -
    -

    Returns boolean

    -
-
- -
    - -
  • -

    Returns information whether the server is online or offline.

    -
    -

    Returns boolean

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Collection.Dictionary.html b/docs/interfaces/node_modules__types_xrm.Xrm.Collection.Dictionary.html deleted file mode 100644 index 78eba3c..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Collection.Dictionary.html +++ /dev/null @@ -1,143 +0,0 @@ -Dictionary | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Collection.ItemCollection.html b/docs/interfaces/node_modules__types_xrm.Xrm.Collection.ItemCollection.html deleted file mode 100644 index e7f38fa..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Collection.ItemCollection.html +++ /dev/null @@ -1,301 +0,0 @@ -ItemCollection | xrm-ex
-
- -
-
-
-
- -

Interface ItemCollection<T>

-
-

Collections are structures to provide access to data that represent an array, but without the ability to modify the data in the array.

-
-
-
-

Type Parameters

-
    -
  • -

    T

-
-

Hierarchy

-
    -
  • ItemCollection
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Applies an operation to all items in this collection.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Gets the item using a delegate matching function

    -
    -
    -

    Parameters

    -
    -

    Returns T[]

    A T[] whose members have been validated by delegate.

    - -
  • - -
  • -

    Gets the item given by the index.

    -
    -
    -

    Parameters

    -
      -
    • -
      itemNumber: number
      -

      The item number to get.

      -
      -
    -

    Returns T

    The T in the itemNumber-th place.

    - -
  • - -
  • -

    Gets the item given by the index.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      TSubType

    -
    -

    Parameters

    -
      -
    • -
      itemNumber: number
      -

      The item number to get.

      -
      -
    -

    Returns TSubType

    The T in the itemNumber-th place.

    - -
    -

    See

    Controls.Control.getName() for Control-naming schemes.

    -
  • - -
  • -

    Gets the item given by the key.

    -
    -
    -

    Parameters

    -
      -
    • -
      itemName: string
      -

      The item name to get.

      -
      -
    -

    Returns T

    The T matching the key itemName.

    - -
    -

    See

    Controls.Control.getName() for Control-naming schemes.

    -
  • - -
  • -

    Gets the item given by the key.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      TSubType

    -
    -

    Parameters

    -
      -
    • -
      attributeName: string
    -

    Returns TSubType

    The T matching the key itemName.

    - -
    -

    See

    Controls.Control.getName() for Control-naming schemes.

    -
  • - -
  • -

    Gets the entire array of T.

    -
    -

    Returns T[]

    A T[].

    - -
-
- -
    - -
  • -

    Gets the length of the collection.

    -
    -

    Returns number

    The length.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.CommandProperties.html b/docs/interfaces/node_modules__types_xrm.Xrm.CommandProperties.html deleted file mode 100644 index 802bbe4..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.CommandProperties.html +++ /dev/null @@ -1,190 +0,0 @@ -CommandProperties | xrm-ex
-
- -
-
-
-
- -

Interface CommandProperties

-
-

used in RibbonDiffXml actions

-
-
-
-

Hierarchy

-
    -
  • CommandProperties
-
-
-
- -
-
-

Properties

-
- -
CommandValueId: string
-

A string that is sent with the command event when a button is clicked.

-
-
-
- -
MenuItemId: string
-

A reference from a control to the Id of a menu item.

-

Most entities will not return a MenuItemId value. Only the following entities will return this value:

-
    -
  • BusinessUnit
  • -
  • Connection
  • -
  • CustomerAddress
  • -
  • Equipment
  • -
  • Goal
  • -
  • InvoiceDetail
  • -
  • Mailbox
  • -
  • MailMergeTemplate
  • -
  • PartnerApplication
  • -
  • QueueItem
  • -
  • QuoteDetail
  • -
  • RoutingRuleItem
  • -
  • SalesOrderDetail
  • -
  • ServiceAppointment
  • -
  • SharePointDocumentLocation
  • -
  • SharePointSite
  • -
  • Territory
  • -
-
-
-
- -
SourceControlId: string
-

The Id value of the Ribbon control that initiated the event.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AddControlNotificationOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AddControlNotificationOptions.html deleted file mode 100644 index cb1a668..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AddControlNotificationOptions.html +++ /dev/null @@ -1,230 +0,0 @@ -AddControlNotificationOptions | xrm-ex
-
- -
-
-
-
- -

Interface AddControlNotificationOptions

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of actions

-
-
-
- -
messages: string[]
-

The message to display in the notification. -In the current release, only the first message specified in this array will be displayed.

-
-
-
- -
notificationLevel?: Xrm.Controls.NotificationLevel
-

Defines the type of notification.

-
-
-
- -
uniqueId: string
-

The ID to use to clear this notification when using the clearNotification method.

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteCommand.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteCommand.html deleted file mode 100644 index df1084b..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteCommand.html +++ /dev/null @@ -1,241 +0,0 @@ -AutoCompleteCommand | xrm-ex
-
- -
-
-
-
- -

Interface AutoCompleteCommand

-
-

Interface for command of AutoCompleteResultSet. This is displayed at the bottom of the auto complete view

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
-
-

Properties

-
- -
icon?: string
-

Url of the icon to display

-
-
-
- -
id: string
-

The Identifier

-
-
-
- -
label: string
-

Label to display at the bottom of the auto complete view

-
-
-
-

Methods

-
- -
    - -
  • -

    Action to perform when user clicks on label

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteResult.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteResult.html deleted file mode 100644 index b6d0cff..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteResult.html +++ /dev/null @@ -1,223 +0,0 @@ -AutoCompleteResult | xrm-ex
-
- -
-
-
-
- -

Interface AutoCompleteResult

-
-

Interface for Result value of AutoCompleteResultSet

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
fields: string[]
-

Display value(s) for this auto-complete option

-
-
-
- -
icon?: string
-

Url of the icon to display

-
-
-
- -
id: string | number
-

The Identifier

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteResultSet.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteResultSet.html deleted file mode 100644 index f1a2b76..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoCompleteResultSet.html +++ /dev/null @@ -1,213 +0,0 @@ -AutoCompleteResultSet | xrm-ex
-
- -
-
-
-
- -

Interface AutoCompleteResultSet

-
-

Interface for showAutoComplete argument

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- - -

Command to show/execute at the bottom of the results displayed

-
-
-
- - -

Results to show

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoLookupControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoLookupControl.html deleted file mode 100644 index dc5c64c..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.AutoLookupControl.html +++ /dev/null @@ -1,706 +0,0 @@ -AutoLookupControl | xrm-ex
-
- -
-
-
-
- -

Interface AutoLookupControl

-
-

Interface for Auto Lookup Control. -This is not an Entity Lookup, but a control that supports AutoComplete / KeyPress Events (Text or Number)

-
-
-

Remarks

This interface is not supported for CRM mobile clients (phones or tablets) and the interactive service hub. It is only available for Updated entities.

- -

Deprecated

Deprecated in v9.

- -

See

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the keypress event so that the function is called when you type a character in the specific text or number field. -For a sample JavaScript code that uses the addOnKeyPress method to configure the auto-completion experience, see Sample: Auto-complete in CRM controls.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Use this to manually fire an event handler that you created for a specific text or number field to be executed on the keypress event.

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the latest value in a control as the user types characters in a specific text or number field. -This method helps you to build interactive experiences by validating data and alerting users as they type characters in a control. -The getValue method is different from the attribute getValue method because the control method retrieves the value from the control -as the user is typing in the control as opposed to the attribute getValue method that retrieves the value after the user commits (saves) the field.

    -
    -

    Returns string

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Hides the auto-completion drop-down list configured for a specific text field

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Use this to remove an event handler for a text or number field that you added using addOnKeyPress.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs -Remarks: If an anonymous function is set using addOnKeyPress, it can’t be removed using this method.

    -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Shows upt to 10 matching strings in a drop-down list as users press keys to type charactrer in a specific text field. -On selecting an item in the drop-down list, the value in the text field changes to the selected item, the drop-down list disappears, and the OnChange event for the text field is invoked

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.BooleanControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.BooleanControl.html deleted file mode 100644 index 6633d54..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.BooleanControl.html +++ /dev/null @@ -1,544 +0,0 @@ -BooleanControl | xrm-ex
-
- -
-
-
-
- -

Interface BooleanControl

-
-

Interface for a Boolean (yes/no) control.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Control.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Control.html deleted file mode 100644 index 22efe9f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Control.html +++ /dev/null @@ -1,325 +0,0 @@ -Control | xrm-ex
-
- -
-
-
- -
-

Interface for controls.

-
-
-

See

UiElement

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Gets a reference to the Section parent of the control.

    -
    -

    Returns Xrm.Controls.Section

    The parent Section.

    - -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ControlNotificationAction.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ControlNotificationAction.html deleted file mode 100644 index e613c24..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ControlNotificationAction.html +++ /dev/null @@ -1,221 +0,0 @@ -ControlNotificationAction | xrm-ex
-
- -
-
-
-
- -

Interface ControlNotificationAction

-
-

interface to define the actions on a control notification

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
actions: (() => void)[]
-

Array of functions. The corresponding actions for the message.

-
-
-

Type declaration

-
    -
  • -
      -
    • (): void
    • -
    • -

      Returns void

-
-
- -
message?: string
-

The body message of the notification to be displayed to the user. Limit your message to 100 characters for optimal user experience.

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.DateControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.DateControl.html deleted file mode 100644 index 1debcc9..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.DateControl.html +++ /dev/null @@ -1,579 +0,0 @@ -DateControl | xrm-ex
-
- -
-
-
-
- -

Interface DateControl

-
-

Interface for a Date control.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the status of the time-of-day component of the Date control.

    -
    -

    Returns boolean

    true if the time is shown, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility of the time component of the Date control.

    -
    -
    -

    Parameters

    -
      -
    • -
      showTimeValue: boolean
      -

      true to show, false to hide the time value.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FieldControlOutput.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FieldControlOutput.html deleted file mode 100644 index 61a5ab8..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FieldControlOutput.html +++ /dev/null @@ -1,197 +0,0 @@ -FieldControlOutput | xrm-ex
-
- -
-
-
-
- -

Interface FieldControlOutput

-
-

Hierarchy

-
    -
  • FieldControlOutput
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
value: any
-

Output value from the control

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FooterSection.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FooterSection.html deleted file mode 100644 index 1ed37ba..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FooterSection.html +++ /dev/null @@ -1,229 +0,0 @@ -FooterSection | xrm-ex
-
- -
-
-
-
- -

Interface FooterSection

-
-

Hierarchy

-
    -
  • FooterSection
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Returns the footer section visibility.

    -
    -

    Returns boolean

    -
    -

    Remarks

    Available only for Unified Interface. Footers aren't supported after 2021 wave 2 release.

    - -

    See

    External Link: Important notices

    -
-
- -
    - -
  • -

    Sets the visibility of the footer section.

    -
    -
    -

    Parameters

    -
      -
    • -
      bool: boolean
      -

      Specify true to show the footer section; false to hide the footer section.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Available only for Unified Interface. Footers aren't supported after 2021 wave 2 release.

    - -

    See

    External Link: Important notices

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FormItem.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FormItem.html deleted file mode 100644 index 30b5e52..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FormItem.html +++ /dev/null @@ -1,271 +0,0 @@ -FormItem | xrm-ex
-
- -
-
-
-
- -

Interface FormItem

-
-

Interface for an entity's form selector item.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the unique identifier of the form.

    -
    -

    Returns string

    The identifier, in Guid format.

    - -
-
- -
    - -
  • -

    Gets the label for the form.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Returns a value that indicates whether the form is currently visible.

    -
    -

    Returns boolean

    true if the form is visible; false otherwise.

    - -
-
- -
    - -
  • -

    Navigates the user to this form.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value that indicates whether the form is visible.

    -
    -
    -

    Parameters

    -
      -
    • -
      isVisible: boolean
      -

      Specify true to show the form; false to hide the form.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FormSelector.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FormSelector.html deleted file mode 100644 index 939fd16..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FormSelector.html +++ /dev/null @@ -1,226 +0,0 @@ -FormSelector | xrm-ex
-
- -
-
-
-
- -

Interface FormSelector

-
-

Interface for the form selector API.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
-
-

Properties

-
- - -

A reference to the collection of available forms.

-
-
-
-

Methods

-
- -
    - -
  • -

    Gets current form.

    -
    -

    Returns Xrm.Controls.FormItem

    The current item.

    - -
    -

    Remarks

    When only one form is available this method will return null.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FramedControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FramedControl.html deleted file mode 100644 index 65d4afb..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.FramedControl.html +++ /dev/null @@ -1,397 +0,0 @@ -FramedControl | xrm-ex
-
- -
-
-
-
- -

Interface FramedControl

-
-

Interface for a framed control, which is either a Web Resource or an Iframe.

-
-
-

See

Control

- -

Remarks

An Iframe control provides additional methods, so use IframeControl where - appropriate. Silverlight controls should use SilverlightControl.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns the content window that represents an IFRAME or web resource.

    -
    -

    Returns Promise<Window>

    A promise that contains a content window instance representing an IFRAME or web resource.

    - -
    -

    Remarks

    This method is supported only on Unified Interface. The implementer is expected to call -a custom function within the returned window that will receive the Xrm and formContext objects as -parameters.

    -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Gets the DOM element containing the control.

    -
    -

    Returns HTMLIFrameElement

    The container object.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
-
- -
    - -
  • -

    Gets the URL value of the control.

    -
    -

    Returns string

    The source URL.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the URL value of the control.

    -
    -
    -

    Parameters

    -
      -
    • -
      src: string
      -

      The source URL.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid-1.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid-1.html deleted file mode 100644 index d7000b3..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid-1.html +++ /dev/null @@ -1,241 +0,0 @@ -Grid | xrm-ex
-
- -
-
-
- -
-

Interface for a grid. Use Grid methods to access information about data in the grid. Grid is returned by the -GridControl.getGrid method.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
-
- -
    - -
  • -

    Returns the total number of records in the Grid.

    -
    -

    Returns number

    The total record count.

    - -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridEntity.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridEntity.html deleted file mode 100644 index 0e12fd6..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridEntity.html +++ /dev/null @@ -1,270 +0,0 @@ -GridEntity | xrm-ex
-
- -
-
-
-
- -

Interface GridEntity

-
-

Interface for a grid entity. Use the GridEntity methods to access data about the specific records in the rows. -GridEntity is returned by the GridRowData.getEntity method.

-
-
-

Deprecated

Use GridRow.data.entity instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns the logical name for the record in the row.

    -
    -

    Returns string

    The entity name.

    - -
    -

    Deprecated

    Use GridRow.data.entity.getEntityName() instead.

    -
-
- -
    - -
  • -

    Returns a LookupValue that references this record.

    -
    -

    Returns Xrm.LookupValue

    The entity reference.

    - -
    -

    Deprecated

    Use GridRow.data.entity.getEntityReference() instead.

    -
-
- -
    - -
  • -

    Returns the id for the record in the row.

    -
    -

    Returns string

    The identifier of the GridEntity, in GUID format.

    - -
    -

    Example

    Example return: "{00000000-0000-0000-0000-000000000000}"
    -
    - -

    Deprecated

    Use GridRow.data.entity.getId() instead.

    -
-
- -
    - -
  • -

    Returns the primary attribute value for the record in the row. (Commonly the name.)

    -
    -

    Returns string

    The primary attribute value.

    - -
    -

    Deprecated

    Use GridRow.data.entity.getPrimaryAttributeValue() instead.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridRow.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridRow.html deleted file mode 100644 index 9bc1448..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridRow.html +++ /dev/null @@ -1,233 +0,0 @@ -GridRow | xrm-ex
-
- -
-
-
- -
-

Interface for a grid row. Use the GridRow.getData method to access the GridRowData. A collection of GridRow is -returned by Grid.getRows and Grid.getSelectedRows methods. -In V9 - this is essentailly a form context

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
-
-

Properties

-
- -
data: Data
-

Provides methods to work with the row data.

-
-
-
-

Methods

-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridRowData.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridRowData.html deleted file mode 100644 index 60f26c5..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Grid.GridRowData.html +++ /dev/null @@ -1,217 +0,0 @@ -GridRowData | xrm-ex
-
- -
-
-
-
- -

Interface GridRowData

-
-

Interface for grid row data. Use the GridRowData.getEntity method to access the GridEntity. GridRowData is -returned by the GridRow.getData method.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Returns the GridEntity for the GridRowData.

    -
    -

    Returns Xrm.Controls.Grid.GridEntity

    The entity.

    - -
    -

    Deprecated

    Use GridRow.data.entity instead of using GridRow.getData().getEntity().

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.GridControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.GridControl.html deleted file mode 100644 index 2862c60..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.GridControl.html +++ /dev/null @@ -1,546 +0,0 @@ -GridControl | xrm-ex
-
- -
-
-
-
- -

Interface GridControl

-
-

Interface for a CRM grid control.

-
-
-

See

Control

-
-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Use this method to add event handlers to the GridControl's OnLoad event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    This method returns context information about the GridControl.

    -
    -

    Returns GridControlContext

    The context type.

    - -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the logical name of the table data displayed in the grid.

    -
    -

    Returns string

    The logical name of the table data displayed in the grid.

    - -
-
- -
    - -
  • -

    Gets the FetchXML query that represents the current data, including filtered and sorted data, in the grid control.

    -
    -

    Returns string

    The FetchXML query.

    - -
-
- -
    - -
  • -

    Get access to the Grid available in the GridControl (gridContext).

    -
    -

    Returns Xrm.Controls.Grid

    The Grid object.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
-
- -
    - -
  • -

    Gets information about the relationship used to filter the subgrid.

    -
    -

    Returns GridRelationship

    A relationship object.

    - -
-
- -
    - -
  • -

    Gets the URL of the current grid control.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional client: GridClient
      -

      Indicates the client type.

      -
      -
    -

    Returns string

    Gets the URL of the current grid control.

    - -
-
- -
    - -
  • -

    Use this method to get access to the ViewSelector available for the GridControl when it is configured to display views.

    -
    -

    Returns Xrm.Controls.ViewSelector

    The view selector.

    - -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Displays the associated grid for the grid.

    -
    -

    Returns void

    -
    -

    Remarks

    This method does nothing if the grid is not filtered based on a relationship.

    -
-
- -
    - -
  • -

    Refreshes the sub grid.

    -
    -

    Returns void

    -
    -

    Remarks

    Not available during the "on load" event of the form.

    -
-
- -
-
- -
    - -
  • -

    Use this method to remove event handlers from the GridControl's OnLoad event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: (() => void)
      -

      The handler.

      -
      -
      -
        -
      • -
          -
        • (): void
        • -
        • -

          Returns void

    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.GridRelationship.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.GridRelationship.html deleted file mode 100644 index b845363..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.GridRelationship.html +++ /dev/null @@ -1,241 +0,0 @@ -GridRelationship | xrm-ex
-
- -
-
-
-
- -

Interface GridRelationship

-
-

Object containing information about the relationship used to filter the subgrid.

-
-
-
-

Hierarchy

-
    -
  • GridRelationship
-
-
-
- -
-
-

Properties

-
- -
attributeName: string
-

Name of the column

-
-
-
- -
name: string
-

Name of the relationship

-
-
-
- -
navigationPropertyName: string
-

Name of the navigation property for this relationship.

-
-
-
- -
relationshipType: RelationshipType
-

Returns one of the following values to indicate the relationship type.

-
-
-
- -
roleType: RoleType
-

Returns one of the following values to indicate the role type of relationship

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.HeaderSection.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.HeaderSection.html deleted file mode 100644 index 14fd71e..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.HeaderSection.html +++ /dev/null @@ -1,313 +0,0 @@ -HeaderSection | xrm-ex
-
- -
-
-
-
- -

Interface HeaderSection

-
-

Hierarchy

-
    -
  • HeaderSection
-
-
-
- -
-
-

Methods

-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the header's body visibility.

    -
    -
    -

    Parameters

    -
      -
    • -
      bool: boolean
      -

      Specify true to show the body; false to hide the body.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Available only for Unified Interface.

    - -

    See

    External Link: setBodyVisible (Client API reference)

    -
-
- -
    - -
  • -

    Sets the command bar visibility.

    -
    -
    -

    Parameters

    -
      -
    • -
      bool: boolean
      -

      Specify true to show the command bar; false to hide the command bar.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Available only for Unified Interface.

    - -

    See

    External Link: setCommandBarVisible (Client API reference)

    -
-
- -
    - -
  • -

    Sets the tab navigator visibility.

    -
    -
    -

    Parameters

    -
      -
    • -
      bool: boolean
      -

      Specify true to show the tab navigator; false to hide the tab navigator.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Available only for Unified Interface.

    - -

    See

    External Link: setTabNavigatorVisible (Client API reference)

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.IframeControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.IframeControl.html deleted file mode 100644 index 9ed44c1..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.IframeControl.html +++ /dev/null @@ -1,436 +0,0 @@ -IframeControl | xrm-ex
-
- -
-
-
-
- -

Interface IframeControl

-
-

Interface for an Iframe control.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns the content window that represents an IFRAME or web resource.

    -
    -

    Returns Promise<Window>

    A promise that contains a content window instance representing an IFRAME or web resource.

    - -
    -

    Remarks

    This method is supported only on Unified Interface. The implementer is expected to call -a custom function within the returned window that will receive the Xrm and formContext objects as -parameters.

    -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets initial URL defined for the Iframe.

    -
    -

    Returns string

    The initial URL.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Gets the DOM element containing the control.

    -
    -

    Returns HTMLIFrameElement

    The container object.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
-
- -
    - -
  • -

    Gets the URL value of the control.

    -
    -

    Returns string

    The source URL.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the URL value of the control.

    -
    -
    -

    Parameters

    -
      -
    • -
      src: string
      -

      The source URL.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.KbSearchControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.KbSearchControl.html deleted file mode 100644 index 45dd6d3..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.KbSearchControl.html +++ /dev/null @@ -1,543 +0,0 @@ -KbSearchControl | xrm-ex
-
- -
-
-
-
- -

Interface KbSearchControl

-
-

Interface for a knowledge base search control

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Opens a search result in the search control by specifying the result number.

    -
    -
    -

    Parameters

    -
      -
    • -
      resultNumber: number
      -

      Numerical value specifying the result number to be opened. Result number starts from 1.

      -
      -
    • -
    • -
      Optional mode: OpenSearchResultMode
      -

      Specify "Inline" or "Popout". "Inline" mode opens the result inline either in the reading pane of the control or in a reference panel tab in case of reference panel. "Popout" mode opens the result in a pop-out window.

      -
      -
    -

    Returns boolean

    Status of opening the specified search result. Returns 1 if successful; 0 if unsuccessful. The method will return -1 if the specified resultNumber value is not present, or if the specified mode value is invalid.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the text used as the search criteria for the knowledge base search control.

    -
    -
    -

    Parameters

    -
      -
    • -
      searchString: string
      -

      The text for the search query.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.KbSearchResult.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.KbSearchResult.html deleted file mode 100644 index 10ab629..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.KbSearchResult.html +++ /dev/null @@ -1,365 +0,0 @@ -KbSearchResult | xrm-ex
-
- -
-
-
-
- -

Interface KbSearchResult

-
-

Interface for a knowledge base search result.

-
-
-
-

Hierarchy

-
    -
  • KbSearchResult
-
-
-
- -
-
-

Properties

-
- -
answer: string
-

The HTML markup containing the content of the article.

-
-
-
- -
articleId: string
-

The article ID that is used as an alternate key.

-
-
-

Remarks

You can use this to see if this article already exists in Microsoft Dataverse.

-
-
- -
articleUid: string
-

The unique article ID. This value is used as an alternate key.

-
-
-
- -
attachmentCount: number
-

Number of attachments in the article.

-
-
-
- -
createdOn: Date
-

The date the article was created in the user's current time zone and format.

-
-
-
- -
expiredDate: Date
-

The date the article was or will be expired.

-
-
-
- -
folderHref: string
-

The link to the folder path of the article.

-
-
-
- -
href: string
-

The direct link to the article.

-
-
-
- -
isAssociated: boolean
-

Indicates whether the article is associated with the parent record.

-
-
-
- -
lastModifiedOn: Date
-

Date on which the article was last modified in the current user's timezone and format.

-
-
-
- -
publicUrl: string
-

Support Portal URL of the article.

-
-
-

Remarks

If the Portal URL option is turned off, this will be blank.

-
-
- -
published: boolean
-

Whether the Article is in published or draft state.

-
-
-
- -
question: string
-

The title of the article.

-
-
-
- -
rating: number
-

The rating of the article.

-
-
-
- -
searchBlurb: string
-

A short snippet of article content which contains the areas where the search query was hit.

-
-
-
- -
serviceDeskUri: string
-

Link to the article. Use this link to open the article.

-
-
-
- -
timesViewed: number
-

The number of times an article is viewed on the portal by customers.

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.LookupControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.LookupControl.html deleted file mode 100644 index 5fc4b23..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.LookupControl.html +++ /dev/null @@ -1,792 +0,0 @@ -LookupControl | xrm-ex
-
- -
-
-
-
- -

Interface LookupControl

-
-

Interface for a Lookup control.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Adds an additional custom filter to the lookup, with the "AND" filter operator. -Can only be used within a "pre search" event handler

    -
    -
    -

    Parameters

    -
      -
    • -
      filter: string
      -

      Specifies the filter, as a serialized FetchXML "filter" node.

      -
      -
    • -
    • -
      Optional entityLogicalName: string
      -

      (Optional) The logical name of the entity.

      -
      -
    -

    Returns void

    -
    -

    See

    addPreSearch

    - -

    Remarks

    If entityLogicalName is not specified, the filter will be applied to all entities - valid for the Lookup control.

    - -

    Example

    Example filter: <filter type="and">
    <condition attribute="address1_city" operator="eq" value="Redmond" />
    </filter> -
    -
-
- -
    - -
  • -

    Adds a custom view for the Lookup dialog.

    -
    -
    -

    Parameters

    -
      -
    • -
      viewId: string
      -

      Unique identifier for the view, in Guid format.

      -
      -
    • -
    • -
      entityName: string
      -

      Name of the entity.

      -
      -
    • -
    • -
      viewDisplayName: string
      -

      Name of the view to display.

      -
      -
    • -
    • -
      fetchXml: string
      -

      The FetchXML query for the view's contents, serialized as a string.

      -
      -
    • -
    • -
      layoutXml: string
      -

      The Layout XML, serialized as a string.

      -
      -
    • -
    • -
      isDefault: boolean
      -

      true, to treat this view as default.

      -
      -
    -

    Returns void

    -
    -

    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 External Link: Guid generator.

    - -

    Example

    Example viewId value: "{00000000-0000-0000-0000-000000000001}"
    -
    - -

    See

    External Link: Layout XML Reference

    -
-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the "lookup tag click" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds a handler to the "pre search" event of the Lookup control.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the unique identifier of the default view.

    -
    -

    Returns string

    The default view, in Guid format.

    - -
    -

    Example

    Example return: "{00000000-0000-0000-0000-000000000000}"
    -
    -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the types of entities allowed in the lookup control.

    -
    -

    Returns string[]

    -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes the handler from the "lookup tag click" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Removes the handler from the "pre search" event of the Lookup control.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the Lookup's default view.

    -
    -
    -

    Parameters

    -
      -
    • -
      viewGuid: string
      -

      Unique identifier for the view.

      -
      -
    -

    Returns void

    -
    -

    Example

    Example viewGuid value: "{00000000-0000-0000-0000-000000000000}"
    -
    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the types of entities allowed in the lookup control.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalNames: string[]
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.MultiSelectOptionSetControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.MultiSelectOptionSetControl.html deleted file mode 100644 index 031dcb3..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.MultiSelectOptionSetControl.html +++ /dev/null @@ -1,607 +0,0 @@ -MultiSelectOptionSetControl | xrm-ex
-
- -
-
-
-
- -

Interface MultiSelectOptionSetControl

-
-

Interface for a standard control.

-
-
-

See

Control

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an option.

    -
    -
    -

    Parameters

    -
      -
    • -
      option: Xrm.OptionSetValue
      -

      The option.

      -
      -
    • -
    • -
      Optional index: number
      -

      (Optional) zero-based index of the option.

      -
      -
    -

    Returns void

    -
    -

    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.

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Clears all options.

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Removes the option matching the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number
      -

      The value.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Navigation.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Navigation.html deleted file mode 100644 index e21a276..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Navigation.html +++ /dev/null @@ -1,205 +0,0 @@ -Navigation | xrm-ex
-
- -
-
-
-
- -

Interface Navigation

-
-

Interface for formContext.ui.navigation.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- - -

A reference to the collection of available navigation items.

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.NavigationItem.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.NavigationItem.html deleted file mode 100644 index 35c134b..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.NavigationItem.html +++ /dev/null @@ -1,304 +0,0 @@ -NavigationItem | xrm-ex
-
- -
-
-
-
- -

Interface NavigationItem

-
-

Interface for a navigation item.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the name of the item.

    -
    -

    Returns string

    The identifier.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.NumberControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.NumberControl.html deleted file mode 100644 index be866ae..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.NumberControl.html +++ /dev/null @@ -1,678 +0,0 @@ -NumberControl | xrm-ex
-
- -
-
-
-
- -

Interface NumberControl

-
-

Interface for a Number control.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the keypress event so that the function is called when you type a character in the specific text or number field. -For a sample JavaScript code that uses the addOnKeyPress method to configure the auto-completion experience, see Sample: Auto-complete in CRM controls.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Use this to manually fire an event handler that you created for a specific text or number field to be executed on the keypress event.

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the latest value in a control as the user types characters in a specific text or number field. -This method helps you to build interactive experiences by validating data and alerting users as they type characters in a control. -The getValue method is different from the attribute getValue method because the control method retrieves the value from the control -as the user is typing in the control as opposed to the attribute getValue method that retrieves the value after the user commits (saves) the field.

    -
    -

    Returns string

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
-
- -
    - -
  • -

    Use this to remove an event handler for a text or number field that you added using addOnKeyPress.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs -Remarks: If an anonymous function is set using addOnKeyPress, it can’t be removed using this method.

    -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Shows upt to 10 matching strings in a drop-down list as users press keys to type charactrer in a specific text field. -On selecting an item in the drop-down list, the value in the text field changes to the selected item, the drop-down list disappears, and the OnChange event for the text field is invoked

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.OptionSetControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.OptionSetControl.html deleted file mode 100644 index 29e2db1..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.OptionSetControl.html +++ /dev/null @@ -1,609 +0,0 @@ -OptionSetControl | xrm-ex
-
- -
-
-
-
- -

Interface OptionSetControl

-
-

Interface for an OptionSet control.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an option.

    -
    -
    -

    Parameters

    -
      -
    • -
      option: Xrm.OptionSetValue
      -

      The option.

      -
      -
    • -
    • -
      Optional index: number
      -

      (Optional) zero-based index of the option.

      -
      -
    -

    Returns void

    -
    -

    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.

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Clears all options.

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Removes the option matching the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number
      -

      The value.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ProcessControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ProcessControl.html deleted file mode 100644 index d29d2c3..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ProcessControl.html +++ /dev/null @@ -1,298 +0,0 @@ -ProcessControl | xrm-ex
-
- -
-
-
-
- -

Interface ProcessControl

-
-

Interface for UI elements which can have the visibility value read.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the display state of the process flow control.

    -
    -

    Returns Xrm.DisplayState

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Reflow the UI of the process control

    -
    -
    -

    Parameters

    -
      -
    • -
      updateUI: boolean
      -

      Specify true to update the UI of the process control; false otherwise.

      -
      -
    • -
    • -
      parentStage: string
      -

      ID of the parent stage.

      -
      -
    • -
    • -
      nextStage: string
      -

      ID of the next stage.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets display state of the process flow control.

    -
    -
    -

    Parameters

    -
      -
    • -
      displayState: Xrm.DisplayState
      -

      Display state of the process flow control, as either "expanded" or "collapsed"

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.QuickFormControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.QuickFormControl.html deleted file mode 100644 index c093f83..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.QuickFormControl.html +++ /dev/null @@ -1,524 +0,0 @@ -QuickFormControl | xrm-ex
-
- -
-
-
-
- -

Interface QuickFormControl

-
-

Interface for a quick view control instance on a form.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the constituent controls in a quick view control.

    -
    -

    Returns Xrm.Controls.Control[]

    An array of controls.

    - -
    -

    Remarks

    Constituent controls in a quick view control are read only.

    -
  • - -
  • -

    Gets the constituent controls in a quick view control.

    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      controlName: string
      -

      Name of the control.

      -
      -
    -

    Returns T

    The control.

    - -
    -

    Remarks

    Constituent controls in a quick view control are read only.

    -
  • - -
  • -

    Gets the constituent controls in a quick view control.

    -
    -
    -

    Parameters

    -
      -
    • -
      controlName: string
      -

      Name of the control.

      -
      -
    -

    Returns Xrm.Controls.Control

    The control.

    - -
    -

    Remarks

    Constituent controls in a quick view control are read only.

    -
  • - -
  • -

    Gets a control by index.

    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      index: number
      -

      The control index.

      -
      -
    -

    Returns T

    The control.

    - -
    -

    Remarks

    Constituent controls in a quick view control are read only.

    -
  • - -
  • -

    Gets a control by index.

    -
    -
    -

    Parameters

    -
      -
    • -
      index: number
      -

      The control index.

      -
      -
    -

    Returns Xrm.Controls.Control

    The control.

    - -
    -

    Remarks

    Constituent controls in a quick view control are read only.

    -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns "quickform"

    Returns a string value ("quickform") that categorizes quick view controls.

    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Returns whether the data binding for the constituent controls in a quick view control is complete.

    -
    -

    Returns boolean

    True is the data binding for a constituent control is complete, otherwise false. - because the quick view form that the control is bound to may not have loaded completely. - As a result, using the getAttribute or any data-related methods on a constituent control might not work. - The isLoaded method for the quick view control helps determine the data binding status for constituent controls in a quick view control.

    - -
    -

    Remarks

    The data binding for the constituent controls in a quick view control may not be complete during the main form OnLoad event

    -
-
- -
    - -
  • -

    Refreshes the data displayed in a quick view control.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Section.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Section.html deleted file mode 100644 index 70bf6dd..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Section.html +++ /dev/null @@ -1,320 +0,0 @@ -Section | xrm-ex
-
- -
-
-
- -
-

Interface for a form section.

-
-
-

See

UiElement

-
-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
-
-

Properties

-
- - -

A reference to the collection of controls within this tab.

-
-
-
-

Methods

-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the section.

    -
    -

    Returns string

    The name.

    - -
-
- -
    - -
  • -

    Gets a reference to the parent Tab.

    -
    -

    Returns Xrm.Controls.Tab

    The parent.

    - -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.SilverlightControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.SilverlightControl.html deleted file mode 100644 index 4c8c4f0..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.SilverlightControl.html +++ /dev/null @@ -1,382 +0,0 @@ -SilverlightControl | xrm-ex
-
- -
-
-
-
- -

Interface SilverlightControl

-
-

Interface for a Silverlight control.

-
-
-

See

Control

- -

Deprecated

The Silverlight WebResource is deprecated on the web client, and is not supported on the new Unified Interface in v9. -Instead of silverlight, use custom controls created using the HTML web resources with HTML5 to create UI components to visualize and interact with data.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the query string value passed to Silverlight.

    -
    -

    Returns string

    The data.

    - -
    -

    Deprecated

    Silverlight is no longer supported. These methods won't be available after October 2020.

    - -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Gets the DOM element containing the control.

    -
    -

    Returns HTMLObjectElement

    The container object.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the query string value passed to Silverlight.

    -
    -
    -

    Parameters

    -
      -
    • -
      data: string
      -

      The data.

      -
      -
    -

    Returns void

    -
    -

    Deprecated

    Silverlight is no longer supported. These methods won't be available after October 2020.

    - -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.StandardControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.StandardControl.html deleted file mode 100644 index 8c5be7d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.StandardControl.html +++ /dev/null @@ -1,566 +0,0 @@ -StandardControl | xrm-ex
-
- -
-
-
-
- -

Interface StandardControl

-
-

Interface for a standard control.

-
-
-

See

Control

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Gets the control's bound attribute.

    -
    -
    -

    Type Parameters

    -
    -

    Returns T

    The attribute.

    - -
  • - -
  • -

    Gets the control's bound attribute.

    -
    -

    Returns Xrm.Attributes.Attribute<any>

    The attribute.

    - -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.StringControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.StringControl.html deleted file mode 100644 index 53743f0..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.StringControl.html +++ /dev/null @@ -1,680 +0,0 @@ -StringControl | xrm-ex
-
- -
-
-
-
- -

Interface StringControl

-
-

Interface for a String control.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the keypress event so that the function is called when you type a character in the specific text or number field. -For a sample JavaScript code that uses the addOnKeyPress method to configure the auto-completion experience, see Sample: Auto-complete in CRM controls.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Use this to manually fire an event handler that you created for a specific text or number field to be executed on the keypress event.

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the latest value in a control as the user types characters in a specific text or number field. -This method helps you to build interactive experiences by validating data and alerting users as they type characters in a control. -The getValue method is different from the attribute getValue method because the control method retrieves the value from the control -as the user is typing in the control as opposed to the attribute getValue method that retrieves the value after the user commits (saves) the field.

    -
    -

    Returns string

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
-
- -
    - -
  • -

    Use this to remove an event handler for a text or number field that you added using addOnKeyPress.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs -Remarks: If an anonymous function is set using addOnKeyPress, it can’t be removed using this method.

    -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Shows upt to 10 matching strings in a drop-down list as users press keys to type charactrer in a specific text field. -On selecting an item in the drop-down list, the value in the text field changes to the selected item, the drop-down list disappears, and the OnChange event for the text field is invoked

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Tab.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Tab.html deleted file mode 100644 index c0198fb..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.Tab.html +++ /dev/null @@ -1,417 +0,0 @@ -Tab | xrm-ex
-
- -
-
-
- -
-

Interface for a form tab.

-
-
-

See

-
-
-

Hierarchy

-
-
-

Implemented by

-
-
-
-
- -
-
-

Properties

-
- - -

A reference to the collection of form sections within this tab.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a function to be called when the TabStateChange event occurs.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Gets display state of the tab.

    -
    -

    Returns Xrm.DisplayState

    The display state, as either "expanded" or "collapsed"

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the tab.

    -
    -

    Returns string

    The name.

    - -
-
- -
    - -
  • -

    Gets a reference to the formContext.ui parent of the tab.

    -
    -

    Returns Ui

    The parent.

    - -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes a function to be called when the TabStateChange event occurs.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets display state of the tab.

    -
    -
    -

    Parameters

    -
      -
    • -
      displayState: Xrm.DisplayState
      -

      Display state of the tab, as either "expanded" or "collapsed"

      -
      -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in the 2021 release wave 1 (April 2021). Use the setFocus method in Unified Interface to ensure the correct tab is opened on a form.

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.TimelineWall.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.TimelineWall.html deleted file mode 100644 index b41df63..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.TimelineWall.html +++ /dev/null @@ -1,333 +0,0 @@ -TimelineWall | xrm-ex
-
- -
-
-
-
- -

Interface TimelineWall

-
-

Interface for a Timeline control.

-
-
-

See

Control

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Refreshes the data displayed in a timelinewall and timer control.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanGetDisabledElement.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanGetDisabledElement.html deleted file mode 100644 index c5aa7f2..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanGetDisabledElement.html +++ /dev/null @@ -1,208 +0,0 @@ -UiCanGetDisabledElement | xrm-ex
-
- -
-
-
-
- -

Interface UiCanGetDisabledElement

-
-

Interface for UI elements which can have the disabled value read.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanGetVisibleElement.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanGetVisibleElement.html deleted file mode 100644 index fbe847d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanGetVisibleElement.html +++ /dev/null @@ -1,211 +0,0 @@ -UiCanGetVisibleElement | xrm-ex
-
- -
-
-
-
- -

Interface UiCanGetVisibleElement

-
-

Interface for UI elements which can have the visibility value read.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanSetDisabledElement.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanSetDisabledElement.html deleted file mode 100644 index d94ab28..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanSetDisabledElement.html +++ /dev/null @@ -1,215 +0,0 @@ -UiCanSetDisabledElement | xrm-ex
-
- -
-
-
-
- -

Interface UiCanSetDisabledElement

-
-

Interface for UI elements which can have the disabled value updated.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanSetVisibleElement.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanSetVisibleElement.html deleted file mode 100644 index 6506909..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiCanSetVisibleElement.html +++ /dev/null @@ -1,218 +0,0 @@ -UiCanSetVisibleElement | xrm-ex
-
- -
-
-
-
- -

Interface UiCanSetVisibleElement

-
-

Interface for UI elements which can have the visibility value updated.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiFocusable.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiFocusable.html deleted file mode 100644 index c279646..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiFocusable.html +++ /dev/null @@ -1,210 +0,0 @@ -UiFocusable | xrm-ex
-
- -
-
-
-
- -

Interface UiFocusable

-
-

Interface for focusable UI elements.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiKeyPressable.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiKeyPressable.html deleted file mode 100644 index b055968..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiKeyPressable.html +++ /dev/null @@ -1,264 +0,0 @@ -UiKeyPressable | xrm-ex
-
- -
-
-
-
- -

Interface UiKeyPressable

-
-

Interface for controls which methods provide immediate feedback or take actions as user types in a control. -Contains methods which can be used to perform data validations in a control even before the user commits (saves) the value in a form.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Use this to add a function as an event handler for the keypress event so that the function is called when you type a character in the specific text or number field. -For a sample JavaScript code that uses the addOnKeyPress method to configure the auto-completion experience, see Sample: Auto-complete in CRM controls.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Use this to manually fire an event handler that you created for a specific text or number field to be executed on the keypress event.

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Use this to remove an event handler for a text or number field that you added using addOnKeyPress.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs -Remarks: If an anonymous function is set using addOnKeyPress, it can’t be removed using this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiLabelElement.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiLabelElement.html deleted file mode 100644 index 7d7799d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiLabelElement.html +++ /dev/null @@ -1,231 +0,0 @@ -UiLabelElement | xrm-ex
-
- -
-
-
-
- -

Interface UiLabelElement

-
-

Interface for UI elements with labels.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiStandardElement.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiStandardElement.html deleted file mode 100644 index 630b8f6..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.UiStandardElement.html +++ /dev/null @@ -1,273 +0,0 @@ -UiStandardElement | xrm-ex
-
- -
-
-
-
- -

Interface UiStandardElement

-
-

Base interface for standard UI elements.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ViewSelector.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ViewSelector.html deleted file mode 100644 index 9dbb6de..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ViewSelector.html +++ /dev/null @@ -1,243 +0,0 @@ -ViewSelector | xrm-ex
-
- -
-
-
-
- -

Interface ViewSelector

-
-

Interface for the view selector. Use the ViewSelector methods to get or set information about the view selector -of the grid control.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Use this method to get a reference to the current view.

    -
    -

    Returns Xrm.LookupValue

    The current view.

    - -
-
- -
    - -
  • -

    Use this method to determine whether the view selector is visible.

    -
    -

    Returns boolean

    true if visible, false if not.

    - -
-
- -
    - -
  • -

    Use this method to set the current view.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ViewSelectorItem.html b/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ViewSelectorItem.html deleted file mode 100644 index 5c34670..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Controls.ViewSelectorItem.html +++ /dev/null @@ -1,208 +0,0 @@ -ViewSelectorItem | xrm-ex
-
- -
-
-
-
- -

Interface ViewSelectorItem

-
-

Interface for a view selector item. This object contains data that identifies a view. Use this as a parameter to -the ViewSelector.setCurrentView method.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Returns a LookupValue that references this view.

    -
    -

    Returns Xrm.LookupValue

    The entity reference.

    - -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.CreateResponse.html b/docs/interfaces/node_modules__types_xrm.Xrm.CreateResponse.html deleted file mode 100644 index a8dbed1..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.CreateResponse.html +++ /dev/null @@ -1,152 +0,0 @@ -CreateResponse | xrm-ex
-
- -
-
-
-
- -

Interface CreateResponse

-
-

Interface for the WebAPI CreateRecord request response

-
-
-
-

Hierarchy

-
    -
  • CreateResponse
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
entityType: string
-
- -
id: string
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Data.html b/docs/interfaces/node_modules__types_xrm.Xrm.Data.html deleted file mode 100644 index 6a02a1b..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Data.html +++ /dev/null @@ -1,315 +0,0 @@ -Data | xrm-ex
-
- -
-
-
-
- -

Interface Data

-
-

Interface for the formContext.data object.

-
-
-
-

Hierarchy

-
    -
  • Data
-
-
-
- -
-
-

Properties

-
- - -

Collection of non-entity data on the form. -Items in this collection are of the same type as the attributes collection, but they are not attributes of the form entity. -In V9 this is only available in the Unified Client

-
-
-
- -
entity: Xrm.Entity
-

The record context of the form

-
-
-
- - -

The process API for formContext.ui.process.

-
-
-

Remarks

This member may be undefined when Process Flows are not used by the current entity.

- -

See

External Link: formContext.data.process (Client API reference)

-
-
-

Methods

-
- -
    - -
  • -

    Adds a function to be called when form data is loaded.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: DataLoadEventHandler
      -

      The function to be executed when the form data loads. The function will be added to the bottom of the event handler pipeline.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Gets a boolean value indicating whether the form data has been modified.

    -
    -

    Returns boolean

    Returns true if the form data has changed; false otherwise.

    - -
-
- -
    - -
  • -

    Gets a boolean value indicating whether all of the form data is valid. This includes the main entity and any unbound attributes.

    -
    -

    Returns boolean

    Returns true if all of the form data is valid; false otherwise.

    - -
-
- -
    - -
  • -

    Asynchronously refreshes data on the form, without reloading the page.

    -
    -
    -

    Parameters

    -
      -
    • -
      save: boolean
      -

      true to save the record, after the refresh.

      -
      -
    -

    Returns PromiseLike<undefined>

    Returns an asynchronous promise.

    - -
-
- -
    - -
  • -

    Removes a function to be called when form data is loaded.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Asynchronously saves the record.

    -
    -

    Returns PromiseLike<undefined>

    Returns an asynchronous promise.

    - -
  • - -
  • -

    Asynchronously saves the record with the option to set callback functions to be executed after the save operation is completed.

    -
    -
    -

    Parameters

    -
      -
    • -
      saveOptions: SaveOptions
      -

      Options to control how appointment, recurring appointment, or service activity records are processed.

      -
      -
    -

    Returns PromiseLike<undefined>

    Returns an asynchronous promise.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.DateFormattingInfo.html b/docs/interfaces/node_modules__types_xrm.Xrm.DateFormattingInfo.html deleted file mode 100644 index ae5be9b..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.DateFormattingInfo.html +++ /dev/null @@ -1,299 +0,0 @@ -DateFormattingInfo | xrm-ex
-
- -
-
-
-
- -

Interface DateFormattingInfo

-
-

Interface for UserSettings.dateFormattingInfo response

-
-
-
-

Hierarchy

-
    -
  • DateFormattingInfo
-
-
-
- -
-
-

Properties

-
- -
AbbreviatedDayNames: string[]
-
- -
AbbreviatedMonthGenitiveNames: string[]
-
- -
AbbreviatedMonthNames: string[]
-
- -
AmDesignator: string
-
- -
Calendar: Calendar
-
- -
CalendarWeekRule: number
-
- -
DateSeparator: string
-
- -
DayNames: string[]
-
- -
FirstDayOfWeek: number
-
- -
FullDateTimePattern: string
-
- -
LongDatePattern: string
-
- -
LongTimePattern: string
-
- -
MonthDayPattern: string
-
- -
MonthGenitiveNames: string[]
-
- -
MonthNames: string[]
-
- -
PmDesignator: string
-
- -
ShortDatePattern: string
-
- -
ShortTimePattern: string
-
- -
ShortestDayNames: string[]
-
- -
SortableDateTimePattern: string
-
- -
TimeSeparator: string
-
- -
UniversalSortableDateTimePattern: string
-
- -
YearMonthPattern: string
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Device-1.html b/docs/interfaces/node_modules__types_xrm.Xrm.Device-1.html deleted file mode 100644 index e3b7ad8..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Device-1.html +++ /dev/null @@ -1,235 +0,0 @@ -Device | xrm-ex
-
- -
-
-
-
- -

Interface Device

-
-

Interface for Xrm.Device API

-
-
-
-

Hierarchy

-
    -
  • Device
-
-
-
- -
-
-

Methods

-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Invokes the device camera to scan the barcode information, such as a product number.

    -
    -

    Returns PromiseLike<string>

    On success, Barcode value is returned as a String

    - -
-
- -
-
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Device.CaptureFileResponse.html b/docs/interfaces/node_modules__types_xrm.Xrm.Device.CaptureFileResponse.html deleted file mode 100644 index 3122e68..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Device.CaptureFileResponse.html +++ /dev/null @@ -1,187 +0,0 @@ -CaptureFileResponse | xrm-ex
-
- -
-
-
-
- -

Interface CaptureFileResponse

-
-

Xrm.Device.captureAudio/captureImage/captureVideo response

-
-
-
-

Hierarchy

-
    -
  • CaptureFileResponse
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
fileContent: string
-

Base64 encoded contents of the file.

-
-
-
- -
fileName: string
-

Name of the audio file.

-
-
-
- -
fileSize: number
-

Size of the file in KB.

-
-
-
- -
mimeType: string
-

File MIME type.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Device.CaptureImageOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.Device.CaptureImageOptions.html deleted file mode 100644 index 78f3cfd..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Device.CaptureImageOptions.html +++ /dev/null @@ -1,197 +0,0 @@ -CaptureImageOptions | xrm-ex
-
- -
-
-
-
- -

Interface CaptureImageOptions

-
-

Options for Xrm.Device.captureImage

-
-
-
-

Hierarchy

-
    -
  • CaptureImageOptions
-
-
-
- -
-
-

Properties

-
- -
allowEdit: boolean
-

Indicates whether to edit the image before saving.

-
-
-
- -
height: number
-

Height of the image to capture.

-
-
-
- -
preferFrontCamera: boolean
-

Indicates whether to capture image using the front camera of the device.

-
-
-
- -
quality: number
-

Quality of the image file in percentage. Number.

-
-
-
- -
width: number
-

Width of the image to capture

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Device.GetCurrentPositionResponse.html b/docs/interfaces/node_modules__types_xrm.Xrm.Device.GetCurrentPositionResponse.html deleted file mode 100644 index e772726..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Device.GetCurrentPositionResponse.html +++ /dev/null @@ -1,167 +0,0 @@ -GetCurrentPositionResponse | xrm-ex
-
- -
-
-
-
- -

Interface GetCurrentPositionResponse

-
-

Interface for Xrm.Device.getCurrentPosition response

-
-
-
-

Hierarchy

-
    -
  • GetCurrentPositionResponse
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
coords: any
-

Contains a set of geographic coordinates along with associated accuracy as well as a set of other optional attributes such as altitude and speed.

-
-
-
- -
timestamp: number
-

Represents the time when the object was acquired and is represented as DOMTimeStamp.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Device.PickFileOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.Device.PickFileOptions.html deleted file mode 100644 index b319a26..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Device.PickFileOptions.html +++ /dev/null @@ -1,177 +0,0 @@ -PickFileOptions | xrm-ex
-
- -
-
-
-
- -

Interface PickFileOptions

-
-

Interface for Xrm.Device.pickFile options

-
-
-
-

Hierarchy

-
    -
  • PickFileOptions
-
-
-
- -
-
-

Properties

-
- -
accept?: PickFileTypes
-

Image file types to select.

-
-
-
- -
allowMultipleFiles?: boolean
-

Indicates whether to allow selecting multiple files.

-
-
-
- -
maximumAllowedFileSize?: number
-

Maximum size of the files(s) to be selected.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Encoding.html b/docs/interfaces/node_modules__types_xrm.Xrm.Encoding.html deleted file mode 100644 index 4190b26..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Encoding.html +++ /dev/null @@ -1,250 +0,0 @@ -Encoding | xrm-ex
-
- -
-
-
-
- -

Interface Encoding

-
-

Interface for Xrm.Encoding API

-
-
-
-

Hierarchy

-
    -
  • Encoding
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Encodes the specified string so that it can be used in HTML.

    -
    -
    -

    Parameters

    -
      -
    • -
      arg: string
      -

      String to be encoded.

      -
      -
    -

    Returns string

    Encoded string

    - -
-
- -
    - -
  • -

    Converts a string that has been HTML-encoded into a decoded string.

    -
    -
    -

    Parameters

    -
      -
    • -
      arg: string
      -

      HTML-encoded string to be decoded.

      -
      -
    -

    Returns string

    Decoded string

    - -
-
- -
    - -
  • -

    Converts a string to an HTML-encoded string.

    -
    -
    -

    Parameters

    -
      -
    • -
      arg: string
      -

      String to be encoded.

      -
      -
    -

    Returns string

    Encoded string

    - -
-
- -
    - -
  • -

    Applies attribute encoding to a string.

    -
    -
    -

    Parameters

    -
      -
    • -
      arg: string
      -

      String to be encoded.

      -
      -
    -

    Returns string

    Encoded string.

    - -
-
- -
    - -
  • -

    Applies XML encoding to a string.

    -
    -
    -

    Parameters

    -
      -
    • -
      arg: string
      -

      String to be encoded.

      -
      -
    -

    Returns string

    Encoded string.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Entity.html b/docs/interfaces/node_modules__types_xrm.Xrm.Entity.html deleted file mode 100644 index 92ff80b..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Entity.html +++ /dev/null @@ -1,392 +0,0 @@ -Entity | xrm-ex
-
- -
-
-
-
- -

Interface Entity

-
-

Interface for the form's record context, formContext.data.entity

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

The collection of attributes for the record.

-
-
-
-

Methods

-
- -
-
- -
    - -
  • -

    Adds a handler to be called when the record is saved.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Gets an serialized-XML string representing data that will be passed to the server upon saving the record.

    -
    -

    Returns string

    The XML in string format.

    - -
    -

    Remarks

    This function does not work with Microsoft Dynamics CRM for tablets.

    - -

    Example

    "<account><name>Contoso</name><accountnumber>55555</accountnumber><telephone2>425
    555-1234</telephone2></account>". -
    -
-
- -
    - -
  • -

    Gets entity's logical name.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
-
- -
    - -
  • -

    Gets the record's unique identifier.

    -
    -

    Returns string

    The identifier, in Guid format.

    - -
    -

    Example

    Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}".
    -
    -
-
- -
    - -
  • -

    Gets a boolean value indicating whether the record has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the record's primary attribute value.

    -
    -

    Returns string

    The primary attribute value.

    - -
    -

    Remarks

    The value for this attribute is used when links to the record are displayed.

    -
-
- -
    - -
  • -

    Gets a boolean value indicating whether all of the entity data is valid.

    -
    -

    Returns boolean

    true if all of the entity data is valid; false otherwise.

    - -
-
- -
-
- -
    - -
  • -

    Removes the handler from the "on save" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Saves the record synchronously with the options to close the form or open a new form after the save is completed.

    -
    -

    Returns void

    -
    -

    Remarks

    When using quick create forms in the web application the saveandnew option is not - applied. It will always work as if saveandclose were used. Quick create forms in - Microsoft Dynamics CRM for tablets will apply the saveandnew behavior.

    - -

    Deprecated

    Deprecated in v9.1; This method is deprecated and we recommend to use the formContext.data.save method.

    -
  • - -
  • -

    Saves the record with the given save mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional saveMode: Xrm.EntitySaveMode
      -

      (Optional) the save mode to save, as either "saveandclose" or "saveandnew". If no parameter is included in the method, the record will simply be saved.

      -
      -
    -

    Returns void

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.EntityFormPageContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.EntityFormPageContext.html deleted file mode 100644 index d970965..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.EntityFormPageContext.html +++ /dev/null @@ -1,190 +0,0 @@ -EntityFormPageContext | xrm-ex
-
- -
-
-
-
- -

Interface EntityFormPageContext

-
-

Interface for input property of returned value from Xrm.Utility.getPageContext()

-
-
-
-

Hierarchy

-
    -
  • EntityFormPageContext
-
-
-
- -
-
-

Properties

-
- -
createFromEntity?: Xrm.LookupValue
-

The parent record that provides default values based on mapped attribute values.

-
-
-
- -
entityId?: string
-

ID of the entity record currently displayed in the form.

-
-
-
- -
entityName: string
-

Logical name of the entity currently displayed.

-
-
-
- -
formId?: string
-

ID of the currently displayed form.

-
-
-
- -
pageType: "entityrecord"
-

The current page type.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.EntityListPageContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.EntityListPageContext.html deleted file mode 100644 index 1318b78..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.EntityListPageContext.html +++ /dev/null @@ -1,180 +0,0 @@ -EntityListPageContext | xrm-ex
-
- -
-
-
-
- -

Interface EntityListPageContext

-
-

Interface for input property of returned value from Xrm.Utility.getPageContext()

-
-
-
-

Hierarchy

-
    -
  • EntityListPageContext
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
entityName: string
-

Logical name of the entity currently displayed.

-
-
-
- -
pageType: "entitylist"
-

The current page type.

-
-
-
- -
viewId?: string
-

ID of the view currently displayed.

-
-
-
- -
viewType?: "savedquery" | "userquery"
-

Type of the view currently displayed.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.EntityReference.html b/docs/interfaces/node_modules__types_xrm.Xrm.EntityReference.html deleted file mode 100644 index 261bd9c..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.EntityReference.html +++ /dev/null @@ -1,184 +0,0 @@ -EntityReference | xrm-ex
-
- -
-
-
-
- -

Interface EntityReference

-
-

Some values pass an EntityReference object: -SelectedControlSelectedItemReferences -SelectedControlAllItemReferences -SelectedControlUnselectedItemReferences

-

Not to be confused with the more commonly used LookupValue .

-
-
-
-

Hierarchy

-
    -
  • EntityReference
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
Id: string
-

A string of the GUID Id value for the record.

-
-
-
- -
Name: string
-

A string of the value of the Primary field for the record.

-
-
-
- -
TypeCode: number
-
-

Deprecated

Use TypeName instead. The number value for custom entities will typically be different from organization to organization and the number value cannot be used reliably for custom entities.

-
-
- -
TypeName: string
-

A string representing the unique name of the entity for the record.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.ErrorResponse.html b/docs/interfaces/node_modules__types_xrm.Xrm.ErrorResponse.html deleted file mode 100644 index 90b6190..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.ErrorResponse.html +++ /dev/null @@ -1,152 +0,0 @@ -ErrorResponse | xrm-ex
-
- -
-
-
-
- -

Interface ErrorResponse

-
-

Interface for the Promise error response arguments

-
-
-
-

Hierarchy

-
    -
  • ErrorResponse
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
errorCode: number
-
- -
message: string
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.Attribute.ChangeEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.Attribute.ChangeEventContext.html deleted file mode 100644 index 387bb5b..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.Attribute.ChangeEventContext.html +++ /dev/null @@ -1,321 +0,0 @@ -ChangeEventContext | xrm-ex
-
- -
-
-
-
- -

Interface ChangeEventContext

-
-

Interface for the event context. -In the API documentation, this is sometimes referred to as the executionContext.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.DataLoadEventArguments.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.DataLoadEventArguments.html deleted file mode 100644 index 1b43299..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.DataLoadEventArguments.html +++ /dev/null @@ -1,187 +0,0 @@ -DataLoadEventArguments | xrm-ex
-
- -
-
-
-
- -

Interface DataLoadEventArguments

-
-

Return value of ()

-
-
-
-

Hierarchy

-
    -
  • DataLoadEventArguments
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.DataLoadEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.DataLoadEventContext.html deleted file mode 100644 index a67ee7f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.DataLoadEventContext.html +++ /dev/null @@ -1,327 +0,0 @@ -DataLoadEventContext | xrm-ex
-
- -
-
-
-
- -

Interface DataLoadEventContext

-
-

Form Data OnLoad event context. -In the API documentation, this is sometimes referred to as the executionContext. -Subscribe to this event with () -Not to be confused with LoadEventContext, registered in the designer.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.EventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.EventContext.html deleted file mode 100644 index 839cb0d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.EventContext.html +++ /dev/null @@ -1,321 +0,0 @@ -EventContext | xrm-ex
-
- -
-
-
-
- -

Interface EventContext

-
-

Interface for the event context. -In the API documentation, this is sometimes referred to as the executionContext.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
    - -
  • -

    Gets a reference to the current form context

    -
    -

    Returns FormContext

    The form context

    - -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.GridControl.LoadEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.GridControl.LoadEventContext.html deleted file mode 100644 index 1e5ed14..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.GridControl.LoadEventContext.html +++ /dev/null @@ -1,321 +0,0 @@ -LoadEventContext | xrm-ex
-
- -
-
-
- -
-

Interface for the event context. -In the API documentation, this is sometimes referred to as the executionContext.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.PostSearchEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.PostSearchEventContext.html deleted file mode 100644 index 2cdc6f0..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.PostSearchEventContext.html +++ /dev/null @@ -1,325 +0,0 @@ -PostSearchEventContext | xrm-ex
-
- -
-
-
- -
-

Interface for the event context. -In the API documentation, this is sometimes referred to as the executionContext.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.ResultOpenedEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.ResultOpenedEventContext.html deleted file mode 100644 index cd1a1e5..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.ResultOpenedEventContext.html +++ /dev/null @@ -1,325 +0,0 @@ -ResultOpenedEventContext | xrm-ex
-
- -
-
-
- -
-

Interface for the event context. -In the API documentation, this is sometimes referred to as the executionContext.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.SelectionEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.SelectionEventContext.html deleted file mode 100644 index 82aa195..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.KbSearchControl.SelectionEventContext.html +++ /dev/null @@ -1,325 +0,0 @@ -SelectionEventContext | xrm-ex
-
- -
-
-
- -
-

Interface for the event context. -In the API documentation, this is sometimes referred to as the executionContext.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventArguments.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventArguments.html deleted file mode 100644 index 1e385c2..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventArguments.html +++ /dev/null @@ -1,189 +0,0 @@ -LoadEventArguments | xrm-ex
-
- -
-
-
-
- -

Interface LoadEventArguments

-
-

Return value of ()

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventArgumentsAsync.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventArgumentsAsync.html deleted file mode 100644 index 22555b6..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventArgumentsAsync.html +++ /dev/null @@ -1,212 +0,0 @@ -LoadEventArgumentsAsync | xrm-ex
-
- -
-
-
-
- -

Interface LoadEventArgumentsAsync

-
-

Return value of ()

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns void

    -
    -

    Summary

    Call to prevent default 10 second timeout in async OnLoad event handlers.

    - -

    Description

    When using an async load the handler will wait for the promise to be fulfilled. -To ensure that a load completes in a timely manner the handler throws a timeout exception after -10 seconds to let you know to tune the async OnLoad event for better performance. When the -disableAsyncTimeout is set, the timeout for that handler will not be applied. It will continue -to wait for that handler's promise to be fulfilled. -This should be used with caution as it might affect the performance of the form load.

    - -

    See

    External Link: Async onLoad timeouts

    -
-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventContext.html deleted file mode 100644 index b9426de..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventContext.html +++ /dev/null @@ -1,332 +0,0 @@ -LoadEventContext | xrm-ex
-
- -
-
-
-
- -

Interface LoadEventContext

-
-

Synchronous Form OnLoad event context. -In the API documentation, this is sometimes referred to as the executionContext. -Asynchronous version see LoadEventContextAsync -Not to be confused with DataLoadEventContext

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventContextAsync.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventContextAsync.html deleted file mode 100644 index dbb014f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LoadEventContextAsync.html +++ /dev/null @@ -1,330 +0,0 @@ -LoadEventContextAsync | xrm-ex
-
- -
-
-
-
- -

Interface LoadEventContextAsync

-
-

Asynchronous Form OnLoad event context. -In the API documentation, this is sometimes referred to as the executionContext. -Synchronous version see LoadEventContext

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LookupTagClickEventArguments.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.LookupTagClickEventArguments.html deleted file mode 100644 index cde15dc..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LookupTagClickEventArguments.html +++ /dev/null @@ -1,213 +0,0 @@ -LookupTagClickEventArguments | xrm-ex
-
- -
-
-
-
- -

Interface LookupTagClickEventArguments

-
-

Hierarchy

-
    -
  • LookupTagClickEventArguments
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the selected tag value

    -
    -

    Returns TagValue

    The lookups TagValue object

    - -
-
- -
    - -
  • -

    Returns a boolean value to indicate if the lookups onClick has been prevented.

    -
    -

    Returns boolean

    true if saving is prevented, otherwise false.

    - -
-
- -
    - -
  • -

    Prevents the default onClick behaviour from executing. -All remaining "onLookupTagClick" handlers will continue execution.

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LookupTagClickEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.LookupTagClickEventContext.html deleted file mode 100644 index 3a3fce0..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.LookupTagClickEventContext.html +++ /dev/null @@ -1,328 +0,0 @@ -LookupTagClickEventContext | xrm-ex
-
- -
-
-
-
- -

Interface LookupTagClickEventContext

-
-

Interface for the event context. -In the API documentation, this is sometimes referred to as the executionContext.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.ProcessStatusChangedEventArguments.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.ProcessStatusChangedEventArguments.html deleted file mode 100644 index 020bd2f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.ProcessStatusChangedEventArguments.html +++ /dev/null @@ -1,216 +0,0 @@ -ProcessStatusChangedEventArguments | xrm-ex
-
- -
-
-
-
- -

Interface ProcessStatusChangedEventArguments

-
-

Interface for process status changed event arguments.

-
-
-
-

Hierarchy

-
    -
  • ProcessStatusChangedEventArguments
-
-
-
- -
-
-

Methods

-
- -
-
- -
-
- -
    - -
  • -

    Prevents the stage or status change operation from being submitted to the server.

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.ProcessStatusChangedEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.ProcessStatusChangedEventContext.html deleted file mode 100644 index 5927856..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.ProcessStatusChangedEventContext.html +++ /dev/null @@ -1,329 +0,0 @@ -ProcessStatusChangedEventContext | xrm-ex
-
- -
-
-
-
- -

Interface ProcessStatusChangedEventContext

-
-

Interface for the event context. -In the API documentation, this is sometimes referred to as the executionContext.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventArguments.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventArguments.html deleted file mode 100644 index 2282eb7..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventArguments.html +++ /dev/null @@ -1,249 +0,0 @@ -SaveEventArguments | xrm-ex
-
- -
-
-
-
- -

Interface SaveEventArguments

-
-

Interface for save event arguments.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns XrmEnum.SaveMode

    The save mode.

    - -
    -

    Summary

    Gets save mode, as an integer.

    - -

    Description

    Gets save mode, as an integer.
    -Values returned are:

    -
      -
    • 1 Save
    • -
    • 2 Save and Close
    • -
    • 59 Save and New
    • -
    • 70 AutoSave (Where enabled; can be used with an OnSave handler to conditionally disable auto-saving)
    • -
    • 58 Save as Completed (Activities)
    • -
    • 5 Deactivate
    • -
    • 6 Reactivate
    • -
    • 47 Assign (All user- or team-owned entities)
    • -
    • 7 Send (Email)
    • -
    • 16 Qualify (Lead)
    • -
    • 15 Disqualify (Lead)
    • -
    -
-
- -
    - -
  • -

    Returns a boolean value to indicate if the record's save has been prevented.

    -
    -

    Returns boolean

    true if saving is prevented, otherwise false.

    - -
-
- -
    - -
  • -

    Prevents the save operation from being submitted to the server. -All remaining "on save" handlers will continue execution.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Cancels the save operation if the event handler has a script error, -returns a rejected promise for an async event handler or the operation times out.

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventArgumentsAsync.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventArgumentsAsync.html deleted file mode 100644 index 8a033c6..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventArgumentsAsync.html +++ /dev/null @@ -1,275 +0,0 @@ -SaveEventArgumentsAsync | xrm-ex
-
- -
-
-
-
- -

Interface SaveEventArgumentsAsync

-
-

Interface for save event arguments.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns void

    -
    -

    Summary

    Call to prevent default 10 second timeout in async OnSave event handlers.

    - -

    Description

    When using an async save the handler will wait for the promise to be fulfilled. -To ensure that a save completes in a timely manner the handler throws a timeout exception after -10 seconds to let you know to tune the async OnSave event for better performance. When the -disableAsyncTimeout is set, the timeout for that handler will not be applied. It will continue -to wait for that handler's promise to be fulfilled. -This should be used with caution as it might affect the performance of the form save.

    - -

    See

    External Link: Async onSave timeouts

    -
-
- -
    - -
  • -

    Returns XrmEnum.SaveMode

    The save mode.

    - -
    -

    Summary

    Gets save mode, as an integer.

    - -

    Description

    Gets save mode, as an integer.
    -Values returned are:

    -
      -
    • 1 Save
    • -
    • 2 Save and Close
    • -
    • 59 Save and New
    • -
    • 70 AutoSave (Where enabled; can be used with an OnSave handler to conditionally disable auto-saving)
    • -
    • 58 Save as Completed (Activities)
    • -
    • 5 Deactivate
    • -
    • 6 Reactivate
    • -
    • 47 Assign (All user- or team-owned entities)
    • -
    • 7 Send (Email)
    • -
    • 16 Qualify (Lead)
    • -
    • 15 Disqualify (Lead)
    • -
    -
-
- -
    - -
  • -

    Returns a boolean value to indicate if the record's save has been prevented.

    -
    -

    Returns boolean

    true if saving is prevented, otherwise false.

    - -
-
- -
    - -
  • -

    Prevents the save operation from being submitted to the server. -All remaining "on save" handlers will continue execution.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Cancels the save operation if the event handler has a script error, -returns a rejected promise for an async event handler or the operation times out.

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventContext.html deleted file mode 100644 index c6b2f65..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventContext.html +++ /dev/null @@ -1,333 +0,0 @@ -SaveEventContext | xrm-ex
-
- -
-
-
-
- -

Interface SaveEventContext

-
-

Synchronous Form OnSave event context. -In the API documentation, this is sometimes referred to as the executionContext. -Asynchronous version see SaveEventContextAsync

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventContextAsync.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventContextAsync.html deleted file mode 100644 index 8d5c857..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.SaveEventContextAsync.html +++ /dev/null @@ -1,330 +0,0 @@ -SaveEventContextAsync | xrm-ex
-
- -
-
-
-
- -

Interface SaveEventContextAsync

-
-

Asynchronous Form OnSave event context. -In the API documentation, this is sometimes referred to as the executionContext. -Synchronous version see SaveEventContext

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageChangeEventArguments.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageChangeEventArguments.html deleted file mode 100644 index 443cdc5..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageChangeEventArguments.html +++ /dev/null @@ -1,218 +0,0 @@ -StageChangeEventArguments | xrm-ex
-
- -
-
-
-
- -

Interface StageChangeEventArguments

-
-

Interface for process stage change event arguments.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the destination stage object

    -
    -

    Returns Xrm.ProcessFlow.Stage

    The stage object. For switching between entities, returns the previous stage object

    - -
-
- -
    - -
  • -

    Prevents the stage or status change operation from being submitted to the server.

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageChangeEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageChangeEventContext.html deleted file mode 100644 index 87e6772..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageChangeEventContext.html +++ /dev/null @@ -1,325 +0,0 @@ -StageChangeEventContext | xrm-ex
-
- -
-
-
-
- -

Interface StageChangeEventContext

-
-

Interface for a process stage change event context

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageSelectedEventArguments.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageSelectedEventArguments.html deleted file mode 100644 index 395c78f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageSelectedEventArguments.html +++ /dev/null @@ -1,191 +0,0 @@ -StageSelectedEventArguments | xrm-ex
-
- -
-
-
-
- -

Interface StageSelectedEventArguments

-
-

Interface for process stage selected event arguments.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageSelectedEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageSelectedEventContext.html deleted file mode 100644 index b3178a0..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Events.StageSelectedEventContext.html +++ /dev/null @@ -1,331 +0,0 @@ -StageSelectedEventContext | xrm-ex
-
- -
-
-
-
- -

Interface StageSelectedEventContext

-
-

Interface for the event context. -In the API documentation, this is sometimes referred to as the executionContext.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.ExecuteResponse.html b/docs/interfaces/node_modules__types_xrm.Xrm.ExecuteResponse.html deleted file mode 100644 index 7b28924..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.ExecuteResponse.html +++ /dev/null @@ -1,328 +0,0 @@ -ExecuteResponse | xrm-ex
-
- -
-
-
-
- -

Interface ExecuteResponse

-
-

Interface for the WebAPI Execute request response

-
-
-
-

Hierarchy

-
    -
  • Response -
      -
    • ExecuteResponse
-
-
-
- -
-
-

Properties

-
- -
body: ReadableStream<Uint8Array>
- -
-
- -
bodyUsed: boolean
- -
-
- -
headers: Headers
- -
-
- -
ok: boolean
- -
-
- -
redirected: boolean
- -
-
- -
status: number
- -
-
- -
statusText: string
- -
-
- -
type: ResponseType
- -
-
- -
url: string
- -
-
-

Methods

-
- -
    - -
  • - -

    Returns Promise<ArrayBuffer>

    -
-
- -
    - -
  • - -

    Returns Promise<Blob>

    -
-
- -
    - -
  • - -

    Returns Response

    -
-
- -
    - -
  • - -

    Returns Promise<FormData>

    -
-
- -
    - -
  • - -

    Returns Promise<any>

    -
-
- -
    - -
  • - -

    Returns Promise<string>

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.FormContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.FormContext.html deleted file mode 100644 index ce42b56..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.FormContext.html +++ /dev/null @@ -1,380 +0,0 @@ -FormContext | xrm-ex
-
- -
-
-
-
- -

Interface FormContext

-
-

Interface for formContext

-
-
-
-

Hierarchy

-
    -
  • FormContext -
-
-
-
- -
-
-

Properties

-
data -ui -
-
-

Methods

-
-
-

Properties

-
- -
data: Data
-

Provides methods to work with the form.

-
-
-
- -
ui: Ui
-

Contains properties and methods to retrieve information about the user interface as well as collections for several subcomponents of the form.

-
-
-
-

Methods

-
- -
    - -
  • -

    Gets all attributes.

    -
    -

    Returns Xrm.Attributes.Attribute<any>[]

    An array of attributes.

    - -
  • - -
  • -

    Gets an attribute matching attributeName.

    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      attributeName: string
      -

      Name of the attribute.

      -
      -
    -

    Returns T

    The attribute.

    - -
  • - -
  • -

    Gets an attribute matching attributeName.

    -
    -
    -

    Parameters

    -
      -
    • -
      attributeName: string
      -

      Name of the attribute.

      -
      -
    -

    Returns Xrm.Attributes.Attribute<any>

    The attribute.

    - -
  • - -
  • -

    Gets an attribute by index.

    -
    -
    -

    Parameters

    -
      -
    • -
      index: number
      -

      The attribute index.

      -
      -
    -

    Returns Xrm.Attributes.Attribute<any>

    The attribute.

    - -
  • - -
  • -

    Gets an attribute.

    -
    -
    -

    Parameters

    -
    -

    Returns Xrm.Attributes.Attribute<any>[]

    An array of attribute.

    - -
-
- -
    - -
  • -

    Gets all controls.

    -
    -

    Returns Xrm.Controls.Control[]

    An array of controls.

    - -
  • - -
  • -

    Gets a control matching controlName.

    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      controlName: string
      -

      Name of the control.

      -
      -
    -

    Returns T

    The control.

    - -
  • - -
  • -

    Gets a control matching controlName.

    -
    -
    -

    Parameters

    -
      -
    • -
      controlName: string
      -

      Name of the control.

      -
      -
    -

    Returns Xrm.Controls.Control

    The control.

    - -
  • - -
  • -

    Gets a control by index.

    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      index: number
      -

      The control index.

      -
      -
    -

    Returns T

    The control.

    - -
  • - -
  • -

    Gets a control by index.

    -
    -
    -

    Parameters

    -
      -
    • -
      index: number
      -

      The control index.

      -
      -
    -

    Returns Xrm.Controls.Control

    The control.

    - -
  • - -
  • -

    Gets a control.

    -
    -
    -

    Parameters

    -
    -

    Returns Xrm.Controls.Control[]

    An array of control.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.GlobalContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.GlobalContext.html deleted file mode 100644 index 041b61d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.GlobalContext.html +++ /dev/null @@ -1,520 +0,0 @@ -GlobalContext | xrm-ex
-
- -
-
-
-
- -

Interface GlobalContext

-
-

Interface for the xRM application context.

-
-
-
-

Hierarchy

-
    -
  • GlobalContext
-
-
-
- -
-
-

Properties

-
- - -

The client's context instance.

-
-
-
- -
organizationSettings: OrganizationSettings
-

Returns information about the current organization settings.

-
-
-
- -
userSettings: UserSettings
-

Returns information about the current user settings.

-
-
-
-

Methods

-
- -
    - -
  • -

    Returns information about the advanced configuration settings for the organization.

    -
    -
    -

    Parameters

    -
      -
    • -
      setting: "MaxChildIncidentNumber" | "MaxIncidentMergeNumber"
      -

      Name of the configuration setting.

      -
      -
    -

    Returns number

    -
-
- -
    - -
  • -

    Gets client's base URL for Dynamics CRM

    -
    -

    Returns string

    The client's base URL

    - -
    -

    Example

    // For Dynamics CRM On-Premises:               http(s)://server/org
    // For Dynamics CRM Online: https://org.crm.dynamics.com
    // For Dynamics CRM for Outlook (Offline): http://localhost:2525 -
    -
-
- -
    - -
  • -

    Returns the name of the current business app in Customer Engagement.

    -
    -

    Returns PromiseLike<string>

    -
-
- -
-
- -
    - -
  • -

    Gets the current value of a settings row.

    -
    -
    -

    Parameters

    -
      -
    • -
      settingName: string
      -

      Name of the setting youd like to receive the value from.

      -
      -
    -

    Returns string | number | boolean

    The current value of the setting.

    - -
-
- -
    - -
  • -

    Returns the URL of the current business app in Customer Engagement.

    -
    -

    Returns string

    A string containing the url of the current business app.

    - -
    -

    Example

    // Online        https://**org**.crm.dynamics.com/main.aspx?appid=**GUID**
    // OnPrem https://**server**/**org**/main.aspx?appid=**GUID** -
    -
-
- -
    - -
  • -

    Gets current styling theme.

    -
    -

    Returns Xrm.Theme

    The name of the current theme, as either "default", "Office12Blue", or "Office14Silver"

    - -
    -

    Remarks

    This function does not work with Dynamics CRM for tablets or in the unified interface.

    -
-
- -
-
- -
-
- -
    - -
  • -

    Gets organization's unique name.

    -
    -

    Returns string

    The organization's unique name.

    - -
    -

    Remarks

    This value can be found on the Developer Resources page within Dynamics CRM.

    - -

    Deprecated

    Deprecated in v9. Use uniqueName globalContext.organizationSettings.uniqueName instead.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Gets query string parameters.

    -
    -

    Returns {
        [index: string]: any;
    }

    The query string parameters, in a dictionary object representing name and value pairs.

    - -
      -
    • -
      [index: string]: any
    -
    -

    Deprecated

    Deprecated in v9 (Still applicable in Web Client).

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Returns the difference between the local time and Coordinated Universal Time (UTC).

    -
    -

    Returns number

    The time zone offset, in minutes.

    - -
-
- -
    - -
  • -

    Gets user's unique identifier.

    -
    -

    Returns string

    The user's identifier in Guid format.

    - -
    -

    Deprecated

    Deprecated in v9. Use globalContext.userSettings.userId instead.

    - -

    See

    External Link: Deprecated Client APIs

    - -

    Example

    Example: "{B05EC7CE-5D51-DF11-97E0-00155DB232D0}"
    -
    -
-
- -
-
- -
-
- -
    - -
  • -

    Gets all user security roles.

    -
    -

    Returns string[]

    An array of user role identifiers, in Guid format.

    - -
    -

    Deprecated

    Deprecated in v9. Use globalContext.userSettings.roles instead.

    - -

    See

    External Link: Deprecated Client APIs

    - -

    Example

    Example: ["cf4cc7ce-5d51-df11-97e0-00155db232d0"]
    -
    -
-
- -
    - -
  • -

    Returns the version number of the Dynamics 365 server.

    -
    -

    Returns string

    The version number

    - -
-
- -
    - -
  • -

    Returns a boolean value indicating if the Customer Engagement instance is hosted on- premises or online.

    -
    -

    Returns boolean

    -
-
- -
    - -
  • -

    Prefixes the current organization's unique name to a string; typically a URL path.

    -
    -
    -

    Parameters

    -
      -
    • -
      sPath: string
      -

      Local pathname of the resource.

      -
      -
    -

    Returns string

    A path string with the organization name. Format: "/"+ OrgName + sPath

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.LookupFilterOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.LookupFilterOptions.html deleted file mode 100644 index ef4338f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.LookupFilterOptions.html +++ /dev/null @@ -1,158 +0,0 @@ -LookupFilterOptions | xrm-ex
-
- -
-
-
-
- -

Interface LookupFilterOptions

-
-

Interface for options used in Xrm.Utility.lookupObjects(LookupOptions) filters

-
-
-
-

Hierarchy

-
    -
  • LookupFilterOptions
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
entityLogicalName: string
-

The entity type to which to apply this filter.

-
-
-
- -
filterXml: string
-

The FetchXML filter element to apply.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.LookupOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.LookupOptions.html deleted file mode 100644 index 93317a6..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.LookupOptions.html +++ /dev/null @@ -1,231 +0,0 @@ -LookupOptions | xrm-ex
-
- -
-
-
-
- -

Interface LookupOptions

-
-

Interface for options used in Xrm.Utility.lookupObjects

-
-
-
-

Hierarchy

-
    -
  • LookupOptions
-
-
-
- -
-
-

Properties

-
- -
allowMultiSelect?: boolean
-

Indicates whether the lookup allows more than one item to be selected.

-
-
-
- -
defaultEntityType?: string
-

The default entity type to use.

-
-
-
- -
defaultViewId?: string
-

The default view to use.

-
-
-
- -
disableMru?: boolean
-

Decides whether to display the most recently used(MRU) item.

-
-
-

Remarks

Available only for Unified Interface.

-
-
- -
entityTypes: string[]
-

The entity types to display.

-
-
-
- - -

Used to filter the results.

-
-
-
- -
searchText?: string
-

Indicates the default search term for the lookup control. -This is supported only on Unified Interface.

-
-
-
- -
showBarcodeScanner?: boolean
-

Indicates whether the lookup control should show the barcode scanner in mobile clients.

-
-
-
- -
viewIds?: string[]
-

The views to be available in the view picker. Only system views are supported.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.LookupValue.html b/docs/interfaces/node_modules__types_xrm.Xrm.LookupValue.html deleted file mode 100644 index 6176bc9..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.LookupValue.html +++ /dev/null @@ -1,171 +0,0 @@ -LookupValue | xrm-ex
-
- -
-
-
-
- -

Interface LookupValue

-
-

Interface for a Lookup value.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
entityType: string
-

Type of the entity.

-
-
-
- -
id: string
-

The identifier.

-
-
-
- -
name?: string
-

The name

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.AttributeMetadata.html b/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.AttributeMetadata.html deleted file mode 100644 index 481e632..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.AttributeMetadata.html +++ /dev/null @@ -1,195 +0,0 @@ -AttributeMetadata | xrm-ex
-
- -
-
-
-
- -

Interface AttributeMetadata

-
-

Type to hold the Attribute metadata as part of the EntityMetadata

-
-
-
-

Hierarchy

-
    -
  • AttributeMetadata
-
-
-
- -
-
-

Properties

-
- -
AttributeType: AttributeTypeCode
-
- -
DefaultFormValue: number
-
- -
DisplayName: string
-
- -
EntityLogicalName: string
-
- -
LogicalName: string
-
-
- -
OptionSet: OptionMetadata[]
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.EntityMetadata.html b/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.EntityMetadata.html deleted file mode 100644 index ad07bd3..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.EntityMetadata.html +++ /dev/null @@ -1,535 +0,0 @@ -EntityMetadata | xrm-ex
-
- -
-
-
-
- -

Interface EntityMetadata

-
-

Types returned by a call to getEntityMetadata

-
-
-
-

Hierarchy

-
    -
  • EntityMetadata
-
-
-
- -
-
-

Properties

-
- -
ActivityTypeMask: number
-
- - -
-
- -
AutoRouteToOwnerQueue: boolean
-
- -
CanBeInManyToMany: boolean
-
- -
CanBePrimaryEntityInRelationship: boolean
-
- -
CanBeRelatedEntityInRelationship: boolean
-
- -
CanCreateAttributes: boolean
-
- -
CanCreateCharts: boolean
-
- -
CanCreateForms: boolean
-
- -
CanCreateViews: boolean
-
- -
CanEnableSyncToExternalSearchIndex: boolean
-
- -
CanModifyAdditionalSettings: boolean
-
- -
CanTriggerWorkflow: boolean
-
- -
Description: Label
-
- -
DisplayCollectionName: Label
-
- -
DisplayName: Label
-
- -
EntityColor: string
-
- -
EntitySetName: string
-
- -
IconLargeName: string
-
- -
IconMediumName: string
-
- -
IconSmallName: string
-
- -
IsActivity: boolean
-
- -
IsActivityParty: boolean
-
- -
IsAuditEnabled: boolean
-
- -
IsAvailableOffline: boolean
-
- -
IsBPFEntity: boolean
-
- -
IsChildEntity: boolean
-
- -
IsConnectionsEnabled: boolean
-
- -
IsCustomEntity: boolean
-
- -
IsCustomizable: boolean
-
- -
IsDocumentManagementEnabled: boolean
-
- -
IsDuplicateDetectionEnabled: boolean
-
- -
IsEnabledForCharts: boolean
-
- -
IsImportable: boolean
-
- -
IsIntersect: boolean
-
- -
IsMailMergeEnabled: boolean
-
- -
IsManaged: boolean
-
- -
IsMappable: boolean
-
- -
IsOneNotIntegrationEnabled: boolean
-
- -
IsOptimisitcConcurrencyEnabled: boolean
-
- -
IsQuickCreateEnabled: boolean
-
- -
IsReadingPaneEnabled: boolean
-
- -
IsRenameable: boolean
-
- -
IsStateModelAware: boolean
-
- -
IsValidForAdvancedFind: boolean
-
- -
IsValidForQueue: boolean
-
- -
IsVisibleInMobileClient: boolean
-
- -
LogicalCollectionName: string
-
- -
LogicalName: string
-
- -
ObjectTypeCode: number
-
- -
OwnershipTypeCode: number
-
- -
PrimaryIdAttribute: string
-
- -
PrimaryImageAttribute: string
-
- -
PrimaryNameAttribute: string
-
- -
RecurrenceBaseEntityLogicalName: string
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.Label.html b/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.Label.html deleted file mode 100644 index 4532415..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.Label.html +++ /dev/null @@ -1,164 +0,0 @@ -Label | xrm-ex
-
- -
-
-
- -
-

Type to hold Labels as part of the EntityMetadata

-
-
-
-

Hierarchy

-
    -
  • Label
-
-
-
- -
-
-

Properties

-
- -
LocalizedLabels: LocalizedLabel[]
-
-
- -
UserLocalizedLabel: LocalizedLabel
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.LocalizedLabel.html b/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.LocalizedLabel.html deleted file mode 100644 index 1faf805..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.LocalizedLabel.html +++ /dev/null @@ -1,161 +0,0 @@ -LocalizedLabel | xrm-ex
-
- -
-
-
-
- -

Interface LocalizedLabel

-
-

Type to hold a Label as part of the EntityMetadata

-
-
-
-

Hierarchy

-
    -
  • LocalizedLabel
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
Label: string
-
- -
LanguageCode: number
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.OptionMetadata.html b/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.OptionMetadata.html deleted file mode 100644 index dab739e..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Metadata.OptionMetadata.html +++ /dev/null @@ -1,217 +0,0 @@ -OptionMetadata | xrm-ex
-
- -
-
-
-
- -

Interface OptionMetadata

-
-

Type to hold the optionset metadata as part of the EntityMetadata

-
-
-
-

Hierarchy

-
    -
  • OptionMetadata
-
-
-
- -
-
-

Properties

-
- -
Color: string
-
- -
Description: Label
-
- -
ExternalValue: any
-
- -
HasChanged: boolean
-
- -
IsManaged: boolean
-
- -
Label: Label
-
- -
MetadataId: string
-
- -
State: number
-
- -
TransitionData: any
-
- -
Value: number
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Mobile.html b/docs/interfaces/node_modules__types_xrm.Xrm.Mobile.html deleted file mode 100644 index b8fd914..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Mobile.html +++ /dev/null @@ -1,155 +0,0 @@ -Mobile | xrm-ex
-
- -
-
-
-
- -

Interface Mobile

-
-

Interface for methods to create and manage records in the mobile clients (for phones tablets).

-
-
-
-

Hierarchy

-
    -
  • Mobile
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
offline: MobileOffline
-

Provides methods to create and manage records in the mobile clients while working in the offline mode.

-
-
-

See

- -

Deprecated

Use offline instead. Xrm.WebApi.offline is implemented differently than Xrm.Mobile.offline

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.MobileOffline.html b/docs/interfaces/node_modules__types_xrm.Xrm.MobileOffline.html deleted file mode 100644 index 0bc8825..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.MobileOffline.html +++ /dev/null @@ -1,387 +0,0 @@ -MobileOffline | xrm-ex
-
- -
-
-
-
- -

Interface MobileOffline

-
-

Interface for the Mobile.offline methods to create and manage records in the mobile clients while working in the offline mode.

-
-
-

Deprecated

Use offline instead. Xrm.WebApi.offline is implemented differently than Xrm.Mobile.offline

- -

See

-
-
-

Hierarchy

-
    -
  • MobileOffline
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Creates an entity record in mobile clients while working in the offline mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityType: string
      -

      The logical name of the entity.

      -
      -
    • -
    • -
      data: {
          [attributeName: string]: any;
      }
      -

      A dictionary object containing key : value pairs for the record to create.

      -
      -
      -
        -
      • -
        [attributeName: string]: any
    -

    Returns PromiseLike<OfflineOperationSuccessCallbackObject>

    Returns an asynchronous promise.

    - -
    -

    Remarks

    You cannot create intersect and activity party entities.
    - Only the following attribute types are supported in offline mode:
    - BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName
    - Integer, Lookup, Memo, Money, Owner, Picklist, String, State
    - Status, UniqueIdentifier

    - -

    Deprecated

    Use createRecord instead.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Returns whether an entity is offline enabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityType: string
      -

      The logical name of the entity.

      -
      -
    -

    Returns boolean

    True if the entity is offline enabled; otherwise False.

    - -
-
- -
    - -
  • -

    Retrieves a collection of entity records in mobile clients while working in the offline mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityType: string
      -

      The logical name of the entity.

      -
      -
    • -
    • -
      Optional options: string
      -

      (Optional) The logical name of the entity

      -
      -
    • -
    • -
      Optional maxPageSize: number
      -

      (Optional) A positive number to indicates the number of entity records to be returned per page.

      -
        -
      • If you do not specify this parameter, the default value is passed as 5000.
      • -
      • If the number of records being retrieved is more than maxPageSize, an @odata.nextLink property -will be returned, and you can use the value of the @odata.nextLink property with a new GET -request to return next set of records.
      • -
      -
      -
    -

    Returns PromiseLike<{
        [key: string]: any;
    }[]>

    Returns an asynchronous promise.

    - -
    -

    Remarks

    A maximum of 5000 related records can be retrieved when using $expand.

    -
      -
    • Only $select option can be specified within $expand.
    • -
    • $skip query option is not supported.
    • -
    • Only the following attribute types are supported in offline mode:
      - BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName
      - Integer, Lookup, Memo, Money, Owner, Picklist, String, State
      - Status, UniqueIdentifier
    • -
    - -

    Deprecated

    Use retrieveMultipleRecords instead.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Retrieves an entity record in mobile clients while working in the offline mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityType: string
      -

      The logical name of the entity.

      -
      -
    • -
    • -
      id: string
      -

      GUID of the record to retrieve.

      -
      -
    • -
    • -
      Optional options: string
      -

      (Optional) OData system query options to retrieve your data. Supports $select and $expand

      -
      -
    -

    Returns PromiseLike<OfflineOperationSuccessCallbackObject>

    Returns an asynchronous promise.

    - -
    -

    Example

    Example options

    -
    options: ?$select=name&$expand=primarycontactid($select=contactid,fullname)
    -
    - -

    Remarks

    Only $select option can be specified within $expand.
    - Only the following attribute types are supported in offline mode:
    - BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName
    - Integer, Lookup, Memo, Money, Owner, Picklist, String, State
    - Status, UniqueIdentifier

    - -

    Deprecated

    Use retrieveRecord instead.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Updates an entity record in mobile clients while working in the offline mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityType: string
      -

      The logical name of the entity.

      -
      -
    • -
    • -
      id: string
      -

      GUID of the record to update.

      -
      -
    • -
    • -
      data: {
          [attributeName: string]: any;
      }
      -

      A dictionary object containing key : value pairs for the record to update.

      -
      -
      -
        -
      • -
        [attributeName: string]: any
    -

    Returns PromiseLike<OfflineOperationSuccessCallbackObject>

    Returns an asynchronous promise.

    - -
    -

    Remarks

    You cannot update intersect and activity party entities.
    - Only the following attribute types are supported in offline mode:
    - BigInt, Boolean, Customer, DateTime, Decimal, Double, EntityName
    - Integer, Lookup, Memo, Money, Owner, Picklist, String, State
    - Status, UniqueIdentifier

    - -

    Deprecated

    Use updateRecord instead.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation-1.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation-1.html deleted file mode 100644 index f319586..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation-1.html +++ /dev/null @@ -1,333 +0,0 @@ -Navigation | xrm-ex
-
- -
-
-
-
- -

Interface Navigation

-
-

Interface for the Xrm.Navigation API

-
-
-
-

Hierarchy

-
    -
  • Navigation
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Navigates to the specified page.

    -
    -
    -

    Parameters

    -
    -

    Returns PromiseLike<any>

    -
-
- -
    - -
  • -

    Displays an alert dialog containing a message and a button.

    -
    -
    -

    Parameters

    -
      -
    • -
      alertStrings: AlertStrings
      -

      The strings to be used in the alert dialog.

      -
      -
    • -
    • -
      Optional alertOptions: DialogSizeOptions
      -

      The height and width options for alert dialog

      -
      -
    -

    Returns PromiseLike<any>

    -
-
- -
    - -
  • -

    Displays a confirmation dialog box containing a message and two buttons.

    -
    -
    -

    Parameters

    -
      -
    • -
      confirmStrings: ConfirmStrings
      -

      The strings to be used in the confirm dialog.

      -
      -
    • -
    • -
      Optional confirmOptions: DialogSizeOptions
      -

      The height and width options for alert dialog

      -
      -
    -

    Returns PromiseLike<ConfirmResult>

    -
-
- -
    - -
  • -

    Displays an error dialog.

    -
    -
    -

    Parameters

    -
      -
    • -
      errorOptions: ErrorDialogOptions
      -

      An object to specify the options for error dialog.

      -
      -
    -

    Returns PromiseLike<any>

    -
-
- -
    - -
  • -

    Opens a file.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Opens a URL, including file URLs.

    -
    -
    -

    Parameters

    -
      -
    • -
      url: string
      -

      URL to open.

      -
      -
    • -
    • -
      Optional openUrlOptions: DialogSizeOptions
      -

      Options to open the URL

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Opens an HTML web resource.

    -
    -
    -

    Parameters

    -
      -
    • -
      webResourceName: string
      -

      Name of the HTML web resource.

      -
      -
    • -
    • -
      Optional windowOptions: OpenWebresourceOptions
      -

      (Optional) Window options for opening the web resource. - It is advised to use encodeURIcomponent() to encode the value.

      -
      -
    • -
    • -
      Optional data: string
    -

    Returns void

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.AlertStrings.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.AlertStrings.html deleted file mode 100644 index 5ee0dbe..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.AlertStrings.html +++ /dev/null @@ -1,185 +0,0 @@ -AlertStrings | xrm-ex
-
- -
-
-
-
- -

Interface AlertStrings

-
-

Hierarchy

-
    -
  • AlertStrings
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
confirmButtonLabel?: string
-

(Optional) The confirm button label.If you do not specify the button label, OK is used as the button label.

-
-
-
- -
text: string
-

The message to be displyed in the alert dialog.

-
-
-
- -
title?: string
-

(Optional) The title of the alert dialog.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ConfirmResult.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ConfirmResult.html deleted file mode 100644 index 2e9bea1..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ConfirmResult.html +++ /dev/null @@ -1,169 +0,0 @@ -ConfirmResult | xrm-ex
-
- -
-
-
-
- -

Interface ConfirmResult

-
-

An object with the confirmed (Boolean) attribute is passed that indicates whether the confirm button was clicked to close the dialog.

-
-
-
-

Hierarchy

-
    -
  • ConfirmResult
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
confirmed: boolean
-

true if the confirm button was clicked to close the dialog.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ConfirmStrings.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ConfirmStrings.html deleted file mode 100644 index c6fc84d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ConfirmStrings.html +++ /dev/null @@ -1,205 +0,0 @@ -ConfirmStrings | xrm-ex
-
- -
-
-
-
- -

Interface ConfirmStrings

-
-

Hierarchy

-
    -
  • ConfirmStrings
-
-
-
- -
-
-

Properties

-
- -
cancelButtonLabel?: string
-

(Optional) The cancel button label. If you do not specify the cancel button label, Cancel is used as the button label.

-
-
-
- -
confirmButtonLabel?: string
-

(Optional) The confirm button label.If you do not specify the button label, OK is used as the button label.

-
-
-
- -
subtitle?: string
-

(Optional) The subtitle to be displayed in the confirmation dialog.

-
-
-
- -
text: string
-

The message to be displyed in the alert dialog.

-
-
-
- -
title?: string
-

(Optional) The title to be displyed in the confirmation dialog.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.CustomPage.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.CustomPage.html deleted file mode 100644 index ad55407..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.CustomPage.html +++ /dev/null @@ -1,192 +0,0 @@ -CustomPage | xrm-ex
-
- -
-
-
- -
-

Hierarchy

-
    -
  • CustomPage
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
entityName?: string
-

The logical name of the table to be made available in the custom page via Param("entityName").

-
-
-
- -
name: string
-

The logic name o the custom page to open.

-
-
-
- -
pageType: "custom"
-
- -
recordId?: string
-

ID of the table record to be made available in the custom page via Param("recordId").

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.Dashboard.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.Dashboard.html deleted file mode 100644 index 8f2fe77..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.Dashboard.html +++ /dev/null @@ -1,172 +0,0 @@ -Dashboard | xrm-ex
-
- -
-
-
- -
-

Hierarchy

-
    -
  • Dashboard
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
dashboardId?: string
-

The GUID of the dashboard to load. If not specified, navigates to the default dashboard

-
-
-
- -
pageType: "dashboard"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.DialogSizeOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.DialogSizeOptions.html deleted file mode 100644 index 67dad63..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.DialogSizeOptions.html +++ /dev/null @@ -1,177 +0,0 @@ -DialogSizeOptions | xrm-ex
-
- -
-
-
-
- -

Interface DialogSizeOptions

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
height: number
-

Height of the alert dialog in pixels.

-
-
-
- -
width: number
-

Width of the alert dialog pixels.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.EntityFormOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.EntityFormOptions.html deleted file mode 100644 index 8fc51ce..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.EntityFormOptions.html +++ /dev/null @@ -1,338 +0,0 @@ -EntityFormOptions | xrm-ex
-
- -
-
-
-
- -

Interface EntityFormOptions

-
-

Entity form options for opening the form

-
-
-
-

Hierarchy

-
    -
  • EntityFormOptions
-
-
-
- -
-
-

Properties

-
- -
cmdbar?: boolean
-

Indicates whether to display the command bar.If you do not specify this parameter, the command bar is displayed by default.

-
-
-
- -
createFromEntity?: Xrm.LookupValue
-

Designates a record that will provide default values based on mapped attribute values.The lookup object has the following String properties: entityType, id, and name (optional).

-
-
-
- -
entityId?: string
-

ID of the entity record to display the form for.

-
-
-
- -
entityName?: string
-

Logical name of the entity to display the form for.

-
-
-
- -
formId?: string
-

ID of the form instance to be displayed.

-
-
-
- -
height?: number
-

Height of the form window to be displayed in pixels.

-
-
-
- -
isCrossEntityNavigate?: boolean
-

Undocumented at this time

-
-
-
- -
isOfflineSyncError?: boolean
-

Undocumented at this time

-
-
-
- - -

Controls whether the navigation bar is displayed and whether application navigation is available using the areas and subareas defined in the sitemap.Valid vlaues are: "on", "off", or "entity".

-
    -
  • on: The navigation bar is displayed.This is the default behavior if the navBar parameter is not used.
  • -
  • off: The navigation bar is not displayed.People can navigate using other user interface elements or the back and forward buttons.
  • -
  • entity: On an entity form, only the navigation options for related entities are available.After navigating to a related entity, a back button is displayed in the navigation bar to allow returning to the original record.
  • -
-
-
-
- -
openInNewWindow?: boolean
-

Indicates whether to display form in a new window.

-
-
-
- -
processId?: string
-

ID of the business process to be displayed on the form.

-
-
-
- -
processInstanceId?: string
-

ID of the business process instance to be displayed on the form.

-
-
-
- -
relationship?: Relationship
-

Define a relationship object to display the related records on the form.

-
-
-
- -
selectedStageId?: string
-

ID of the selected stage in business process instance.

-
-
-
- -
useQuickCreateForm?: boolean
-

Indicates whether to open a quick create form.

-
-
-
- -
width?: number
-

Width of the form window to be displayed in pixels.

-
-
-
- -
windowPosition?: WindowPositions
-

Specify one of the following values for the window position of the form on the screen:

-
    -
  • 1:center
  • -
  • 2:side
  • -
-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ErrorDialogOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ErrorDialogOptions.html deleted file mode 100644 index 78a14a0..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.ErrorDialogOptions.html +++ /dev/null @@ -1,192 +0,0 @@ -ErrorDialogOptions | xrm-ex
-
- -
-
-
-
- -

Interface ErrorDialogOptions

-
-

Details to show in the Error dialog

-
-
-
-

Hierarchy

-
    -
  • ErrorDialogOptions
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
details?: string
-

Details about the error. When you specify this, the Download Log File button is available in the error message, -and clicking it will let users download a text file with the content specified in this attribute.

-
-
-
- -
errorCode?: number
-

The error code. If you just set errorCode, the message for the error code is automatically -retrieved from the server and displayed in the error dialog. -If you specify an invalid errorCode value, an error dialog with a default error message is displyed.

-
-
-
- -
message?: string
-

The message to be displayed in the error dialog.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.FileDetails.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.FileDetails.html deleted file mode 100644 index 493a63d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.FileDetails.html +++ /dev/null @@ -1,195 +0,0 @@ -FileDetails | xrm-ex
-
- -
-
-
- -
-

Hierarchy

-
    -
  • FileDetails
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
fileContent: string
-

Contents of the file.

-
-
-
- -
fileName: string
-

Name of the file.

-
-
-
- -
fileSize: number
-

Size of the file in KB.

-
-
-
- -
mimeType: string
-

String. MIME type of the file.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.NavigationOptions-1.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.NavigationOptions-1.html deleted file mode 100644 index c5320ff..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.NavigationOptions-1.html +++ /dev/null @@ -1,208 +0,0 @@ -NavigationOptions | xrm-ex
-
- -
-
-
-
- -

Interface NavigationOptions

-
-

Options for navigating to a page: whether to open inline or in a dialog. If you don't specify this parameter, page is opened inline by default.

-
-
-
-

Hierarchy

-
    -
  • NavigationOptions
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
height?: number | SizeValue
-

The width of dialog. To specify the width in pixels, just type a numeric value. To specify the width in percentage, specify an object of type

-
-
-
- -
position?: 2 | 1
-

Specify 1 to open the dialog in center; 2 to open the dialog on the side. Default is 1 (center).

-
-
-
- -
target: 2 | 1
-

Specify 1 to open the page inline; 2 to open the page in a dialog. -Entity lists can only be opened inline; web resources can be opened either inline or in a dialog.

-
-
-
- -
title?: string
-
- -
width?: number | SizeValue
-

The width of dialog. To specify the width in pixels, just type a numeric value. To specify the width in percentage, specify an object of type

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.NavigationOptions.SizeValue.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.NavigationOptions.SizeValue.html deleted file mode 100644 index 78bccdf..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.NavigationOptions.SizeValue.html +++ /dev/null @@ -1,180 +0,0 @@ -SizeValue | xrm-ex
-
- -
-
-
- -
-

Hierarchy

-
    -
  • SizeValue
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
unit: "%" | "px"
-

The unit of measurement. Specify "%" or "px". Default value is "px"

-
-
-
- -
value: number
-

The numerical value

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.OpenFormResult.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.OpenFormResult.html deleted file mode 100644 index c3e8c6a..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.OpenFormResult.html +++ /dev/null @@ -1,165 +0,0 @@ -OpenFormResult | xrm-ex
-
- -
-
-
-
- -

Interface OpenFormResult

-
-

Hierarchy

-
    -
  • OpenFormResult
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
savedEntityReference: Xrm.LookupValue[]
-

Identifies the record displayed or created

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.OpenWebresourceOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.OpenWebresourceOptions.html deleted file mode 100644 index b754bc8..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.OpenWebresourceOptions.html +++ /dev/null @@ -1,189 +0,0 @@ -OpenWebresourceOptions | xrm-ex
-
- -
-
-
-
- -

Interface OpenWebresourceOptions

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
height: number
-

Height of the alert dialog in pixels.

-
-
-
- -
openInNewWindow: boolean
-

Indicates whether to open the web resource in a new window.

-
-
-
- -
width: number
-

Width of the alert dialog pixels.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputEntityList.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputEntityList.html deleted file mode 100644 index c34a39f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputEntityList.html +++ /dev/null @@ -1,192 +0,0 @@ -PageInputEntityList | xrm-ex
-
- -
-
-
-
- -

Interface PageInputEntityList

-
-

Hierarchy

-
    -
  • PageInputEntityList
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
entityName: string
-

The logical name of the entity to load in the list control.

-
-
-
- -
pageType: "entitylist"
-
- -
viewId?: string
-

The ID of the view to load. If you don't specify it, navigates to the default main view for the entity.

-
-
-
- -
viewType?: "savedquery" | "userquery"
-

Type of view to load. Specify "savedquery" or "userquery".

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputEntityRecord.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputEntityRecord.html deleted file mode 100644 index b16e36f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputEntityRecord.html +++ /dev/null @@ -1,287 +0,0 @@ -PageInputEntityRecord | xrm-ex
-
- -
-
-
-
- -

Interface PageInputEntityRecord

-
-

Hierarchy

-
    -
  • PageInputEntityRecord
-
-
-
- -
-
-

Properties

-
- -
createFromEntity?: Xrm.LookupValue
-

Designates a record that will provide default values based on mapped attribute values. The lookup object has the following String properties: entityType, id, and name (optional).

-
-
-
- -
data?: {
    [attributeName: string]: any;
}
-

A dictionary object that passes extra parameters to the form. Invalid parameters will cause an error.

-
-
-

Type declaration

-
    -
  • -
    [attributeName: string]: any
-
-
- -
entityId?: string
-

ID of the entity record to display the form for. If you don't specify this value, the form will be opened in create mode.

-
-
-
- -
entityName: string
-

Logical name of the entity to display the form for.

-
-
-
- -
formId?: string
-

ID of the form instance to be displayed.

-
-
-
- -
isCrossEntityNavigate?: boolean
-

Indicates whether the form is navigated to from a different entity using cross-entity business process flow.

-
-
-
- -
isOfflineSyncError?: boolean
-

Indicates whether there are any offline sync errors.

-
-
-
- -
pageType: "entityrecord"
-
- -
processId?: string
-

ID of the business process to be displayed on the form.

-
-
-
- -
processInstanceId?: string
-

ID of the business process instance to be displayed on the form.

-
-
-
- -
relationship?: Relationship
-

Define a relationship object to display the related records on the form.

-
-
-
- -
selectedStageId?: string
-

ID of the selected stage in business process instance.

-
-
-
- -
tabName?: string
-

Sets the focus on the tab of the form.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputHtmlWebResource.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputHtmlWebResource.html deleted file mode 100644 index 6e68a18..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.PageInputHtmlWebResource.html +++ /dev/null @@ -1,182 +0,0 @@ -PageInputHtmlWebResource | xrm-ex
-
- -
-
-
-
- -

Interface PageInputHtmlWebResource

-
-

Hierarchy

-
    -
  • PageInputHtmlWebResource
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
data?: string
-

The data to pass to the web resource.

-
-
-
- -
pageType: "webresource"
-
- -
webresourceName: string
-

The name of the web resource to load.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.Relationship.html b/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.Relationship.html deleted file mode 100644 index 0317cae..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Navigation.Relationship.html +++ /dev/null @@ -1,213 +0,0 @@ -Relationship | xrm-ex
-
- -
-
-
-
- -

Interface Relationship

-
-

Hierarchy

-
    -
  • Relationship
-
-
-
- -
-
-

Properties

-
- -
attributeName: string
-

Name of the attribute used for relationship.

-
-
-
- -
name: string
-

Name of the relationship.

-
-
-
- -
navigationPropertyName?: string
-

Name of the navigation property for this relationship.

-
-
-
- -
relationshipType?: RelationshipType
-

Relationship type.Specify one of the following values:

-
    -
  • 0:OneToMany
  • -
  • 1:ManyToMany
  • -
-
-
-
- -
roleType?: RoleType
-

Role type in relationship.Specify one of the following values:

-
    -
  • 1:Referencing
  • -
  • 2:AssociationEntity
  • -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.OptionSetValue.html b/docs/interfaces/node_modules__types_xrm.Xrm.OptionSetValue.html deleted file mode 100644 index 2cc6a88..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.OptionSetValue.html +++ /dev/null @@ -1,160 +0,0 @@ -OptionSetValue | xrm-ex
-
- -
-
-
-
- -

Interface OptionSetValue

-
-

Interface for an OptionSet value.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
text: string
-

The label text.

-
-
-
- -
value: number
-

The value, as a number

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.OrganizationSettings.html b/docs/interfaces/node_modules__types_xrm.Xrm.OrganizationSettings.html deleted file mode 100644 index 0f9b69c..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.OrganizationSettings.html +++ /dev/null @@ -1,232 +0,0 @@ -OrganizationSettings | xrm-ex
-
- -
-
-
-
- -

Interface OrganizationSettings

-
-

Returns information about the current organization settings.

-
-
-
-

Hierarchy

-
    -
  • OrganizationSettings
-
-
-
- -
-
-

Properties

-
- -
baseCurrency: Xrm.LookupValue
-

Returns a lookup object containing the ID, name, and entity type of the base currency for the current organization.

-
-
-
- -
baseCurrencyId: string
-

Returns the ID of the base currency for the current organization.

-
-
-

Deprecated

Deprecated in v9.1; use globalContext.organizationSettings.baseCurrency instead to display name along with the ID.

-
-
- -
defaultCountryCode: string
-

Returns the default country/region code for phone numbers for the current organization.

-
-
-
- -
isAutoSaveEnabled: boolean
-

Indicates whether the auto-save option is enabled for the current organization.

-
-
-
- -
languageId: number
-

Returns the preferred language ID for the current organization.

-
-
-
- -
organizationGeo: string
-

Returns the region of the current organization.

-
-
-
- -
organizationId: string
-

Returns the ID of the current organization.

-
-
-
- -
uniqueName: string
-

Returns the unique name of the current organization.

-
-
-
- -
useSkypeProtocol: boolean
-

Indicates whether the Skype protocol is used for the current organization.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page-1.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page-1.html deleted file mode 100644 index 8c90564..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page-1.html +++ /dev/null @@ -1,410 +0,0 @@ -Page | xrm-ex
-
- -
-
-
-
- -

Interface Page

-
-

Interface for Page context

-
-
-

Deprecated

Use formContext instead.

- -

See

External Link: Deprecated Client APIsa

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
-
-

Properties

-
- -
context: GlobalContext
-

Provides methods to retrieve information specific to an organization, a user, or parameters passed to a page.

-
-
-

Deprecated

Deprecated in v9.

- -

See

External Link: Deprecated Client APIs

-
-
- -
data: Data
-

Provides methods to work with the form.

-
-
-
- -
ui: Ui
-

Contains properties and methods to retrieve information about the user interface as well as collections for several subcomponents of the form.

-
-
-
-

Methods

-
- -
-
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.AddControlNotificationOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.AddControlNotificationOptions.html deleted file mode 100644 index 9ec982c..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.AddControlNotificationOptions.html +++ /dev/null @@ -1,260 +0,0 @@ -AddControlNotificationOptions | xrm-ex
-
- -
-
-
-
- -

Interface AddControlNotificationOptions

-
-
-

Deprecated

Use AddControlNotificationOptions instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of actions

-
-
-
- -
messages: string[]
-

The message to display in the notification. -In the current release, only the first message specified in this array will be displayed.

-
-
-
- -
notificationLevel?: Xrm.Controls.NotificationLevel
-

Defines the type of notification.

-
-
-
- -
uniqueId: string
-

The ID to use to clear this notification when using the clearNotification method.

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Attribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.Attribute.html deleted file mode 100644 index e33c5ae..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Attribute.html +++ /dev/null @@ -1,564 +0,0 @@ -Attribute | xrm-ex
-
- -
-
-
-
- -

Interface Attribute

-
-

Interface for an Entity attribute.

-
-
-

Deprecated

Use Attribute instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Gets the attribute format.

    -
    -

    Returns Xrm.Attributes.AttributeFormat

    The format of the attribute.

    -Values returned are:

    -
      -
    • date (datetime)
    • -
    • datetime (datetime)
    • -
    • duration (integer)
    • -
    • email (string)
    • -
    • language (optionset)
    • -
    • none (integer)
    • -
    • phone (string)
    • -
    • text (string)
    • -
    • textarea (string)
    • -
    • tickersymbol (string)
    • -
    • timezone (optionset)
    • -
    • url (string)
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns any

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: any
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteCommand.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteCommand.html deleted file mode 100644 index d90ad28..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteCommand.html +++ /dev/null @@ -1,269 +0,0 @@ -AutoCompleteCommand | xrm-ex
-
- -
-
-
-
- -

Interface AutoCompleteCommand

-
-

Interface for command of AutoCompleteResultSet. This is displayed at the bottom of the auto complete view

-
-
-

Deprecated

Use AutoCompleteCommand instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
-
-

Properties

-
- -
icon?: string
-

Url of the icon to display

-
-
-
- -
id: string
-

The Identifier

-
-
-
- -
label: string
-

Label to display at the bottom of the auto complete view

-
-
-
-

Methods

-
- -
    - -
  • -

    Action to perform when user clicks on label

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteResult.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteResult.html deleted file mode 100644 index 5e2b364..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteResult.html +++ /dev/null @@ -1,250 +0,0 @@ -AutoCompleteResult | xrm-ex
-
- -
-
-
-
- -

Interface AutoCompleteResult

-
-

Interface for Result value of AutoCompleteResultSet

-
-
-

Deprecated

Use AutoCompleteResult instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
fields: string[]
-

Display value(s) for this auto-complete option

-
-
-
- -
icon?: string
-

Url of the icon to display

-
-
-
- -
id: string | number
-

The Identifier

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteResultSet.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteResultSet.html deleted file mode 100644 index a63eab7..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoCompleteResultSet.html +++ /dev/null @@ -1,239 +0,0 @@ -AutoCompleteResultSet | xrm-ex
-
- -
-
-
-
- -

Interface AutoCompleteResultSet

-
-

Interface for showAutoComplete argument

-
-
-

Deprecated

Use AutoCompleteResultSet instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- - -

Command to show/execute at the bottom of the results displayed

-
-
-
- - -

Results to show

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoLookupControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoLookupControl.html deleted file mode 100644 index a2d75ee..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.AutoLookupControl.html +++ /dev/null @@ -1,725 +0,0 @@ -AutoLookupControl | xrm-ex
-
- -
-
-
-
- -

Interface AutoLookupControl

-
-

Interface for Auto Lookup Control. -This is not an Entity Lookup, but a control that supports AutoComplete / KeyPress Events (Text or Number)

-
-
-

Remarks

This interface is not supported for CRM mobile clients (phones or tablets) and the interactive service hub. It is only available for Updated entities.

- -

See

StandardControl

- -

Deprecated

Use AutoLookupControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the keypress event so that the function is called when you type a character in the specific text or number field. -For a sample JavaScript code that uses the addOnKeyPress method to configure the auto-completion experience, see Sample: Auto-complete in CRM controls.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Use this to manually fire an event handler that you created for a specific text or number field to be executed on the keypress event.

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the latest value in a control as the user types characters in a specific text or number field. -This method helps you to build interactive experiences by validating data and alerting users as they type characters in a control. -The getValue method is different from the attribute getValue method because the control method retrieves the value from the control -as the user is typing in the control as opposed to the attribute getValue method that retrieves the value after the user commits (saves) the field.

    -
    -

    Returns string

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
-
- -
    - -
  • -

    Use this to remove an event handler for a text or number field that you added using addOnKeyPress.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs -Remarks: If an anonymous function is set using addOnKeyPress, it can’t be removed using this method.

    -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Shows upt to 10 matching strings in a drop-down list as users press keys to type charactrer in a specific text field. -On selecting an item in the drop-down list, the value in the text field changes to the selected item, the drop-down list disappears, and the OnChange event for the text field is invoked

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.BooleanAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.BooleanAttribute.html deleted file mode 100644 index 0e04d2b..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.BooleanAttribute.html +++ /dev/null @@ -1,572 +0,0 @@ -BooleanAttribute | xrm-ex
-
- -
-
-
-
- -

Interface BooleanAttribute

-
-

Interface for a Boolean attribute.

-
-
-

See

EnumAttribute

- -

Deprecated

Use BooleanAttribute instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Gets the attribute format.

    -
    -

    Returns "boolean"

    the string "boolean"

    - -
-
- -
    - -
  • -

    Gets the attribute format.

    -
    -

    Returns Xrm.Attributes.AttributeFormat

    The format of the attribute.

    -Values returned are:

    -
      -
    • date (datetime)
    • -
    • datetime (datetime)
    • -
    • duration (integer)
    • -
    • email (string)
    • -
    • language (optionset)
    • -
    • none (integer)
    • -
    • phone (string)
    • -
    • text (string)
    • -
    • textarea (string)
    • -
    • tickersymbol (string)
    • -
    • timezone (optionset)
    • -
    • url (string)
    • -
    - -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns boolean

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: boolean
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Control.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.Control.html deleted file mode 100644 index 6dd82f6..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Control.html +++ /dev/null @@ -1,342 +0,0 @@ -Control | xrm-ex
-
- -
-
-
-
- -

Interface Control

-
-

Interface for Xrm.Page.ui controls.

-
-
-

See

UiElement

- -

Deprecated

Use Control instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ControlNotificationAction.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.ControlNotificationAction.html deleted file mode 100644 index aaed013..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ControlNotificationAction.html +++ /dev/null @@ -1,247 +0,0 @@ -ControlNotificationAction | xrm-ex
-
- -
-
-
-
- -

Interface ControlNotificationAction

-
-

Interface to define the actions on a control notification

-
-
-

Deprecated

Use ControlNotificationAction instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
actions: (() => void)[]
-

Array of functions. The corresponding actions for the message.

-
-
-

Type declaration

-
    -
  • -
      -
    • (): void
    • -
    • -

      Returns void

-
-
- -
message?: string
-

The body message of the notification to be displayed to the user. Limit your message to 100 characters for optimal user experience.

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.DateAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.DateAttribute.html deleted file mode 100644 index 7dfd436..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.DateAttribute.html +++ /dev/null @@ -1,550 +0,0 @@ -DateAttribute | xrm-ex
-
- -
-
-
-
- -

Interface DateAttribute

-
-

Interface for a Date attribute.

-
-
-

See

Attribute

- -

Deprecated

Use DateAttribute instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns Date

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: Date
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.DateControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.DateControl.html deleted file mode 100644 index 7f4e3d0..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.DateControl.html +++ /dev/null @@ -1,586 +0,0 @@ -DateControl | xrm-ex
-
- -
-
-
-
- -

Interface DateControl

-
-

Interface for a Date control.

-
-
-

See

StandardControl

- -

Deprecated

Use DateControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Entity.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.Entity.html deleted file mode 100644 index 2d394c1..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Entity.html +++ /dev/null @@ -1,481 +0,0 @@ -Entity | xrm-ex
-
- -
-
-
-
- -

Interface Entity

-
-

Interface for the form's record context, Xrm.Page.data.entity

-
-
-

Deprecated

Use Entity instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

The collection of attributes for the record.

-
-
-
-

Methods

-
- -
-
- -
    - -
  • -

    Adds a handler to be called when the record is saved.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Gets an serialized-XML string representing data that will be passed to the server upon saving the record.

    -
    -

    Returns string

    The XML in string format.

    - -
    -

    Remarks

    This function does not work with Microsoft Dynamics CRM for tablets.

    - -

    Example

    "<account><name>Contoso</name><accountnumber>55555</accountnumber><telephone2>425
    555-1234</telephone2></account>". -
    -
-
- -
    - -
  • -

    Gets entity's logical name.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
-
- -
    - -
  • -

    Gets the record's unique identifier.

    -
    -

    Returns string

    The identifier, in Guid format.

    - -
    -

    Example

    Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}".
    -
    -
-
- -
    - -
  • -

    Gets a boolean value indicating whether the record has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the record's primary attribute value.

    -
    -

    Returns string

    The primary attribute value.

    - -
    -

    Remarks

    The value for this attribute is used when links to the record are displayed.

    -
-
- -
    - -
  • -

    Gets a boolean value indicating whether all of the entity data is valid.

    -
    -

    Returns boolean

    true if all of the entity data is valid; false otherwise.

    - -
-
- -
-
- -
-
- -
    - -
  • -

    Saves the record synchronously with the options to close the form or open a new form after the save is completed.

    -
    -

    Returns void

    -
    -

    Remarks

    When using quick create forms in the web application the saveandnew option is not - applied. It will always work as if saveandclose were used. Quick create forms in - Microsoft Dynamics CRM for tablets will apply the saveandnew behavior.

    - -

    Deprecated

    Deprecated in v9.1; This method is deprecated and we recommend to use the formContext.data.save method.

    -
  • - -
  • -

    Saves the record with the given save mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional saveMode: Xrm.EntitySaveMode
      -

      (Optional) the save mode to save, as either "saveandclose" or "saveandnew". If no parameter is included in the method, the record will simply be saved.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.EnumAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.EnumAttribute.html deleted file mode 100644 index cc3edf6..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.EnumAttribute.html +++ /dev/null @@ -1,585 +0,0 @@ -EnumAttribute | xrm-ex
-
- -
-
-
-
- -

Interface EnumAttribute

-
-

Common interface for enumeration attributes (OptionSet and Boolean).

-
-
-

See

Attribute

- -

Deprecated

Use EnumAttribute instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Gets the attribute format.

    -
    -

    Returns Xrm.Attributes.AttributeFormat

    The format of the attribute.

    -Values returned are:

    -
      -
    • date (datetime)
    • -
    • datetime (datetime)
    • -
    • duration (integer)
    • -
    • email (string)
    • -
    • language (optionset)
    • -
    • none (integer)
    • -
    • phone (string)
    • -
    • text (string)
    • -
    • textarea (string)
    • -
    • tickersymbol (string)
    • -
    • timezone (optionset)
    • -
    • url (string)
    • -
    - -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns number | boolean

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number | boolean
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.EventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.EventContext.html deleted file mode 100644 index 723b6ce..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.EventContext.html +++ /dev/null @@ -1,349 +0,0 @@ -EventContext | xrm-ex
-
- -
-
-
-
- -

Interface EventContext

-
-

Interface for the event context.

-
-
-

Deprecated

Use EventContext instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.FormItem.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.FormItem.html deleted file mode 100644 index 535590a..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.FormItem.html +++ /dev/null @@ -1,300 +0,0 @@ -FormItem | xrm-ex
-
- -
-
-
-
- -

Interface FormItem

-
-

Interface for an entity's form selector item.

-
-
-

Deprecated

Use FormItem instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the unique identifier of the form.

    -
    -

    Returns string

    The identifier, in Guid format.

    - -
-
- -
    - -
  • -

    Gets the label for the form.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Returns a value that indicates whether the form is currently visible.

    -
    -

    Returns boolean

    true if the form is visible; false otherwise.

    - -
-
- -
    - -
  • -

    Navigates the user to this form.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value that indicates whether the form is visible.

    -
    -
    -

    Parameters

    -
      -
    • -
      isVisible: boolean
      -

      Specify true to show the form; false to hide the form.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.FormSelector.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.FormSelector.html deleted file mode 100644 index 4e9774a..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.FormSelector.html +++ /dev/null @@ -1,252 +0,0 @@ -FormSelector | xrm-ex
-
- -
-
-
-
- -

Interface FormSelector

-
-

Interface for the form selector API.

-
-
-

Deprecated

Use FormSelector instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
-
-

Properties

-
- - -

A reference to the collection of available forms.

-
-
-
-

Methods

-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.FramedControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.FramedControl.html deleted file mode 100644 index 23aea0b..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.FramedControl.html +++ /dev/null @@ -1,422 +0,0 @@ -FramedControl | xrm-ex
-
- -
-
-
-
- -

Interface FramedControl

-
-

Interface for a framed control, which is either a Web Resource or an Iframe.

-
-
-

See

Control

- -

Remarks

An Iframe control provides additional methods, so use IframeControl where - appropriate. Silverlight controls should use SilverlightControl.

- -

Deprecated

Use FramedControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns the content window that represents an IFRAME or web resource.

    -
    -

    Returns Promise<Window>

    A promise that contains a content window instance representing an IFRAME or web resource.

    - -
    -

    Remarks

    This method is supported only on Unified Interface. The implementer is expected to call -a custom function within the returned window that will receive the Xrm and formContext objects as -parameters.

    -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Gets the DOM element containing the control.

    -
    -

    Returns HTMLIFrameElement

    The container object.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
-
- -
    - -
  • -

    Gets the URL value of the control.

    -
    -

    Returns string

    The source URL.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the URL value of the control.

    -
    -
    -

    Parameters

    -
      -
    • -
      src: string
      -

      The source URL.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.GridControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.GridControl.html deleted file mode 100644 index 4f98fd2..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.GridControl.html +++ /dev/null @@ -1,575 +0,0 @@ -GridControl | xrm-ex
-
- -
-
-
-
- -

Interface GridControl

-
-

Interface for a CRM grid control.

-
-
-

See

Control

- -

Deprecated

Use GridControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Use this method to add event handlers to the GridControl's OnLoad event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the logical name of the table data displayed in the grid.

    -
    -

    Returns string

    The logical name of the table data displayed in the grid.

    - -
-
- -
    - -
  • -

    Gets the FetchXML query that represents the current data, including filtered and sorted data, in the grid control.

    -
    -

    Returns string

    The FetchXML query.

    - -
-
- -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
-
- -
-
- -
    - -
  • -

    Gets the URL of the current grid control.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional client: GridClient
      -

      Indicates the client type.

      -
      -
    -

    Returns string

    Gets the URL of the current grid control.

    - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Displays the associated grid for the grid.

    -
    -

    Returns void

    -
    -

    Remarks

    This method does nothing if the grid is not filtered based on a relationship.

    -
-
- -
    - -
  • -

    Refreshes the sub grid.

    -
    -

    Returns void

    -
    -

    Remarks

    Not available during the "on load" event of the form.

    -
-
- -
-
- -
    - -
  • -

    Use this method to remove event handlers from the GridControl's OnLoad event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: (() => void)
      -

      The handler.

      -
      -
      -
        -
      • -
          -
        • (): void
        • -
        • -

          Returns void

    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.IframeControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.IframeControl.html deleted file mode 100644 index a043501..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.IframeControl.html +++ /dev/null @@ -1,458 +0,0 @@ -IframeControl | xrm-ex
-
- -
-
-
-
- -

Interface IframeControl

-
-

Interface for an Iframe control.

-
-
-

See

FramedControl

- -

Deprecated

Use IframeControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns the content window that represents an IFRAME or web resource.

    -
    -

    Returns Promise<Window>

    A promise that contains a content window instance representing an IFRAME or web resource.

    - -
    -

    Remarks

    This method is supported only on Unified Interface. The implementer is expected to call -a custom function within the returned window that will receive the Xrm and formContext objects as -parameters.

    -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets initial URL defined for the Iframe.

    -
    -

    Returns string

    The initial URL.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Gets the DOM element containing the control.

    -
    -

    Returns HTMLIFrameElement

    The container object.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
-
- -
    - -
  • -

    Gets the URL value of the control.

    -
    -

    Returns string

    The source URL.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the URL value of the control.

    -
    -
    -

    Parameters

    -
      -
    • -
      src: string
      -

      The source URL.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupAttribute.html deleted file mode 100644 index c34e99b..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupAttribute.html +++ /dev/null @@ -1,581 +0,0 @@ -LookupAttribute | xrm-ex
-
- -
-
-
-
- -

Interface LookupAttribute

-
-

Interface a Lookup attribute.

-
-
-

See

Attribute

- -

Deprecated

Use LookupAttribute instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Gets the attribute format.

    -
    -

    Returns Xrm.Attributes.AttributeFormat

    The format of the attribute.

    -Values returned are:

    -
      -
    • date (datetime)
    • -
    • datetime (datetime)
    • -
    • duration (integer)
    • -
    • email (string)
    • -
    • language (optionset)
    • -
    • none (integer)
    • -
    • phone (string)
    • -
    • text (string)
    • -
    • textarea (string)
    • -
    • tickersymbol (string)
    • -
    • timezone (optionset)
    • -
    • url (string)
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets a boolean value indicating whether the Lookup is a multi-value PartyList.

    -
    -

    Returns boolean

    true the attribute is a PartyList, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupControl.html deleted file mode 100644 index 9f5517d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupControl.html +++ /dev/null @@ -1,824 +0,0 @@ -LookupControl | xrm-ex
-
- -
-
-
-
- -

Interface LookupControl

-
-

Interface for a Lookup control.

-
-
-

See

StandardControl

- -

Deprecated

Use LookupControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Adds an additional custom filter to the lookup, with the "AND" filter operator. -Can only be used within a "pre search" event handler

    -
    -
    -

    Parameters

    -
      -
    • -
      filter: string
      -

      Specifies the filter, as a serialized FetchXML "filter" node.

      -
      -
    • -
    • -
      Optional entityLogicalName: string
      -

      (Optional) The logical name of the entity.

      -
      -
    -

    Returns void

    -
    -

    See

    addPreSearch

    - -

    Remarks

    If entityLogicalName is not specified, the filter will be applied to all entities - valid for the Lookup control.

    - -

    Example

    Example filter: <filter type="and">
    <condition attribute="address1_city" operator="eq" value="Redmond" />
    </filter> -
    -
-
- -
    - -
  • -

    Adds a custom view for the Lookup dialog.

    -
    -
    -

    Parameters

    -
      -
    • -
      viewId: string
      -

      Unique identifier for the view, in Guid format.

      -
      -
    • -
    • -
      entityName: string
      -

      Name of the entity.

      -
      -
    • -
    • -
      viewDisplayName: string
      -

      Name of the view to display.

      -
      -
    • -
    • -
      fetchXml: string
      -

      The FetchXML query for the view's contents, serialized as a string.

      -
      -
    • -
    • -
      layoutXml: string
      -

      The Layout XML, serialized as a string.

      -
      -
    • -
    • -
      isDefault: boolean
      -

      true, to treat this view as default.

      -
      -
    -

    Returns void

    -
    -

    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 External Link: Guid generator.

    - -

    Example

    Example viewId value: "{00000000-0000-0000-0000-000000000001}"
    -
    - -

    See

    External Link: Layout XML Reference

    -
-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the "lookup tag click" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds a handler to the "pre search" event of the Lookup control.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the unique identifier of the default view.

    -
    -

    Returns string

    The default view, in Guid format.

    - -
    -

    Example

    Example return: "{00000000-0000-0000-0000-000000000000}"
    -
    -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the types of entities allowed in the lookup control.

    -
    -

    Returns string[]

    -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes the handler from the "lookup tag click" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Removes the handler from the "pre search" event of the Lookup control.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the Lookup's default view.

    -
    -
    -

    Parameters

    -
      -
    • -
      viewGuid: string
      -

      Unique identifier for the view.

      -
      -
    -

    Returns void

    -
    -

    Example

    Example viewGuid value: "{00000000-0000-0000-0000-000000000000}"
    -
    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the types of entities allowed in the lookup control.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalNames: string[]
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupValue.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupValue.html deleted file mode 100644 index 5abb9f7..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.LookupValue.html +++ /dev/null @@ -1,250 +0,0 @@ -LookupValue | xrm-ex
-
- -
-
-
-
- -

Interface LookupValue

-
-

Interface for a Lookup value.

-
-
-

Deprecated

Use LookupValue instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
entityType: string
-

Type of the entity.

-
-
-
- -
id: string
-

The identifier.

-
-
-
- -
name?: string
-

The name

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Navigation.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.Navigation.html deleted file mode 100644 index b9874ab..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Navigation.html +++ /dev/null @@ -1,230 +0,0 @@ -Navigation | xrm-ex
-
- -
-
-
-
- -

Interface Navigation

-
-

Interface for Xrm.Page.ui.navigation.

-
-
-

Deprecated

Use Navigation instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- - -

A reference to the collection of available navigation items.

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.NavigationItem.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.NavigationItem.html deleted file mode 100644 index f8873fd..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.NavigationItem.html +++ /dev/null @@ -1,325 +0,0 @@ -NavigationItem | xrm-ex
-
- -
-
-
-
- -

Interface NavigationItem

-
-

Interface for a navigation item.

-
-
-

See

- -

Deprecated

Use NavigationItem instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the name of the item.

    -
    -

    Returns string

    The identifier.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.NumberAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.NumberAttribute.html deleted file mode 100644 index 6de0763..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.NumberAttribute.html +++ /dev/null @@ -1,619 +0,0 @@ -NumberAttribute | xrm-ex
-
- -
-
-
-
- -

Interface NumberAttribute

-
-

Interface for a Number attribute.

-
-
-

See

Attribute

- -

Deprecated

Use NumberAttribute instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the maximum value allowed.

    -
    -

    Returns number

    The maximum value allowed.

    - -
-
- -
    - -
  • -

    Gets the minimum value allowed.

    -
    -

    Returns number

    The minimum value allowed.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
    - -
  • -

    Gets the attribute's configured precision.

    -
    -

    Returns number

    The total number of allowed decimal places.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns number

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.NumberControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.NumberControl.html deleted file mode 100644 index ad80f83..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.NumberControl.html +++ /dev/null @@ -1,720 +0,0 @@ -NumberControl | xrm-ex
-
- -
-
-
-
- -

Interface NumberControl

-
-

Interface for a Number control.

-
-
-

See

StandardControl

- -

Deprecated

Use NumberControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the keypress event so that the function is called when you type a character in the specific text or number field. -For a sample JavaScript code that uses the addOnKeyPress method to configure the auto-completion experience, see Sample: Auto-complete in CRM controls.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Use this to manually fire an event handler that you created for a specific text or number field to be executed on the keypress event.

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the latest value in a control as the user types characters in a specific text or number field. -This method helps you to build interactive experiences by validating data and alerting users as they type characters in a control. -The getValue method is different from the attribute getValue method because the control method retrieves the value from the control -as the user is typing in the control as opposed to the attribute getValue method that retrieves the value after the user commits (saves) the field.

    -
    -

    Returns string

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
-
- -
    - -
  • -

    Use this to remove an event handler for a text or number field that you added using addOnKeyPress.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs -Remarks: If an anonymous function is set using addOnKeyPress, it can’t be removed using this method.

    -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Shows upt to 10 matching strings in a drop-down list as users press keys to type charactrer in a specific text field. -On selecting an item in the drop-down list, the value in the text field changes to the selected item, the drop-down list disappears, and the OnChange event for the text field is invoked

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetAttribute.html deleted file mode 100644 index b8abf48..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetAttribute.html +++ /dev/null @@ -1,658 +0,0 @@ -OptionSetAttribute | xrm-ex
-
- -
-
-
-
- -

Interface OptionSetAttribute

-
-

Interface an OptionSet attribute.

-
-
-

See

EnumAttribute

- -

Deprecated

Use OptionSetAttribute instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
    - -
  • -

    Gets the label of the currently selected option.

    -
    -

    Returns string

    The current value's label.

    - -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns number

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    The getOptions() method returns option values as strings. You must use parseInt - to convert them to numbers before you can use those values to set the value of an - OptionSet attribute. Attributes on Quick Create Forms will not save values set - with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetControl.html deleted file mode 100644 index 4498f98..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetControl.html +++ /dev/null @@ -1,634 +0,0 @@ -OptionSetControl | xrm-ex
-
- -
-
-
-
- -

Interface OptionSetControl

-
-

Interface for an OptionSet control.

-
-
-

See

StandardControl

- -

Deprecated

Use OptionSetControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an option.

    -
    -
    -

    Parameters

    -
      -
    • -
      option: Xrm.OptionSetValue
      -

      The option.

      -
      -
    • -
    • -
      Optional index: number
      -

      (Optional) zero-based index of the option.

      -
      -
    -

    Returns void

    -
    -

    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.

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Clears all options.

    -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Removes the option matching the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: number
      -

      The value.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetValue.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetValue.html deleted file mode 100644 index 59053e7..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.OptionSetValue.html +++ /dev/null @@ -1,239 +0,0 @@ -OptionSetValue | xrm-ex
-
- -
-
-
-
- -

Interface OptionSetValue

-
-

Interface for an OptionSet value.

-
-
-

Deprecated

Use OptionSetValue instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
text: string
-

The label text.

-
-
-
- -
value: number
-

The value, as a number

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Privilege.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.Privilege.html deleted file mode 100644 index 461a2b3..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Privilege.html +++ /dev/null @@ -1,250 +0,0 @@ -Privilege | xrm-ex
-
- -
-
-
-
- -

Interface Privilege

-
-

Interface for a privilege.

-
-
-

Deprecated

Use Privilege instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
canCreate: boolean
-

True if the user can create.

-
-
-
- -
canRead: boolean
-

True if the user can read.

-
-
-
- -
canUpdate: boolean
-

True if the user can update.

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Process.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.Process.html deleted file mode 100644 index a06f0f2..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Process.html +++ /dev/null @@ -1,282 +0,0 @@ -Process | xrm-ex
-
- -
-
-
-
- -

Interface Process

-
-

Interface for a CRM Business Process Flow instance.

-
-
-

Deprecated

Use Process instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Returns the unique identifier of the process.

    -
    -

    Returns string

    The identifier for this process, in GUID format.

    - -
    -

    Example

    Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}".
    -
    -
-
- -
    - -
  • -

    Returns the name of the process.

    -
    -

    Returns string

    The name.

    - -
-
- -
-
- -
    - -
  • -

    Returns a boolean value to indicate if the process is rendered.

    -
    -

    Returns boolean

    true if the process is rendered, false if not.

    - -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.SaveEventArguments.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.SaveEventArguments.html deleted file mode 100644 index 4504871..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.SaveEventArguments.html +++ /dev/null @@ -1,363 +0,0 @@ -SaveEventArguments | xrm-ex
-
- -
-
-
-
- -

Interface SaveEventArguments

-
-

Interface for save event arguments.

-
-
-

Deprecated

Use SaveEventContext instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.SaveEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.SaveEventContext.html deleted file mode 100644 index 14eeb77..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.SaveEventContext.html +++ /dev/null @@ -1,363 +0,0 @@ -SaveEventContext | xrm-ex
-
- -
-
-
-
- -

Interface SaveEventContext

-
-

Interface for a save event context

-
-
-

Deprecated

Use SaveEventContext instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Section.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.Section.html deleted file mode 100644 index 14a4c5d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Section.html +++ /dev/null @@ -1,341 +0,0 @@ -Section | xrm-ex
-
- -
-
-
-
- -

Interface Section

-
-

Interface for a form section.

-
-
-

See

UiElement

- -

Deprecated

Use Section instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
-
-

Properties

-
- - -

A reference to the collection of controls within this tab.

-
-
-
-

Methods

-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the section.

    -
    -

    Returns string

    The name.

    - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.SilverlightControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.SilverlightControl.html deleted file mode 100644 index 26b4fd2..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.SilverlightControl.html +++ /dev/null @@ -1,404 +0,0 @@ -SilverlightControl | xrm-ex
-
- -
-
-
-
- -

Interface SilverlightControl

-
-

Interface for a Silverlight control.

-
-
-

See

Control

- -

Deprecated

Use SilverlightControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the query string value passed to Silverlight.

    -
    -

    Returns string

    The data.

    - -
    -

    Deprecated

    Silverlight is no longer supported. These methods won't be available after October 2020.

    - -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Gets the DOM element containing the control.

    -
    -

    Returns HTMLObjectElement

    The container object.

    - -
    -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the query string value passed to Silverlight.

    -
    -
    -

    Parameters

    -
      -
    • -
      data: string
      -

      The data.

      -
      -
    -

    Returns void

    -
    -

    Deprecated

    Silverlight is no longer supported. These methods won't be available after October 2020.

    - -

    Remarks

    Unavailable for Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Stage.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.Stage.html deleted file mode 100644 index eec3baa..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Stage.html +++ /dev/null @@ -1,320 +0,0 @@ -Stage | xrm-ex
-
- -
-
-
-
- -

Interface Stage

-
-

Interface for CRM Business Process Flow stages.

-
-
-

Deprecated

Use Stage instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns an object with a getValue method which will return the integer value of the business process flow -category.

    -
    -

    Returns {
        getValue() => StageCategory;
    }

    The stage category.

    - - -
-
- -
    - -
  • -

    Returns the logical name of the entity associated with the stage.

    -
    -

    Returns string

    The entity name.

    - -
-
- -
    - -
  • -

    Returns the unique identifier of the stage.

    -
    -

    Returns string

    The identifier of the Stage, in GUID format.

    - -
    -

    Example

    Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}".
    -
    -
-
- -
    - -
  • -

    Returns the name of the stage.

    -
    -

    Returns string

    The name.

    - -
-
- -
-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageChangeEventArguments.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageChangeEventArguments.html deleted file mode 100644 index 60b3379..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageChangeEventArguments.html +++ /dev/null @@ -1,261 +0,0 @@ -StageChangeEventArguments | xrm-ex
-
- -
-
-
-
- -

Interface StageChangeEventArguments

-
-

Interface for process stage change event arguments.

-
-
-

Deprecated

Use StageChangeEventArguments instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
-
- -
    - -
  • -

    Prevents the stage or status change operation from being submitted to the server.

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageChangeEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageChangeEventContext.html deleted file mode 100644 index 0ba59b8..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageChangeEventContext.html +++ /dev/null @@ -1,364 +0,0 @@ -StageChangeEventContext | xrm-ex
-
- -
-
-
-
- -

Interface StageChangeEventContext

-
-

Interface for a process stage change event context

-
-
-

Deprecated

Use StageChangeEventContext instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageSelectedEventArguments.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageSelectedEventArguments.html deleted file mode 100644 index 650be56..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageSelectedEventArguments.html +++ /dev/null @@ -1,232 +0,0 @@ -StageSelectedEventArguments | xrm-ex
-
- -
-
-
-
- -

Interface StageSelectedEventArguments

-
-

Interface for process stage selected event arguments.

-
-
-

Deprecated

Use StageSelectedEventArguments instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageSelectedEventContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageSelectedEventContext.html deleted file mode 100644 index 705b7dc..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StageSelectedEventContext.html +++ /dev/null @@ -1,364 +0,0 @@ -StageSelectedEventContext | xrm-ex
-
- -
-
-
-
- -

Interface StageSelectedEventContext

-
-

Interface for a process stage select event context

-
-
-

Deprecated

Use StageSelectedEventContext instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the handler's depth, which is the order in which the handler is executed.

    -
    -

    Returns number

    The depth, a 0-based index.

    - -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    -

    Returns T

    The shared variable.

    - -
    -

    Summary

    Gets the shared variable with the specified key.

    - -

    Description

    Gets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

      -

      Generic type parameter.

      -
      -
    -
    -

    Parameters

    -
      -
    • -
      key: string
      -

      The key.

      -
      -
    • -
    • -
      value: T
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Summary

    Sets a shared variable.

    - -

    Description

    Sets the shared variable with the specified key. -Used to pass values between handlers of an event.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StandardControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.StandardControl.html deleted file mode 100644 index 1125c87..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StandardControl.html +++ /dev/null @@ -1,588 +0,0 @@ -StandardControl | xrm-ex
-
- -
-
-
-
- -

Interface StandardControl

-
-

Interface for a standard control.

-
-
-

See

Control

- -

Deprecated

Use StandardControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Step.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.Step.html deleted file mode 100644 index dfe3ce2..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Step.html +++ /dev/null @@ -1,268 +0,0 @@ -Step | xrm-ex
-
- -
-
-
-
- -

Interface Step

-
-

Interface for CRM Business Process Flow steps.

-
-
-

Deprecated

Use Step instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns the logical name of the attribute associated to the step.

    -
    -

    Returns string

    The attribute.

    - -
    -

    Remarks

    Some steps don’t contain an attribute value.

    -
-
- -
    - -
  • -

    Returns the name of the step.

    -
    -

    Returns string

    The name.

    - -
-
- -
    - -
  • -

    Returns whether the step is required in the business process flow.

    -
    -

    Returns boolean

    true if required, false if not.

    - -
    -

    Remarks

    Returns true if the step is marked as required in the Business Process Flow editor; otherwise, false. - There is no connection between this value and the values you can change in the formContext.data.entity - attribute RequiredLevel methods.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StringAttribute.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.StringAttribute.html deleted file mode 100644 index 529a1e7..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StringAttribute.html +++ /dev/null @@ -1,569 +0,0 @@ -StringAttribute | xrm-ex
-
- -
-
-
-
- -

Interface StringAttribute

-
-

Interface for a String attribute.

-
-
-

See

Attribute

- -

Deprecated

Use StringAttribute instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A collection of all the controls on the form that interface with this attribute.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a handler to be called when the attribute's value is changed.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Fire all "on change" event handlers.

    -
    -

    Returns void

    -
-
- -
-
- -
-
- -
    - -
  • -

    Gets a boolean value indicating whether this Attribute has unsaved changes.

    -
    -

    Returns boolean

    true if there are unsaved changes, otherwise false.

    - -
-
- -
    - -
  • -

    Gets maximum length allowed.

    -
    -

    Returns number

    The maximum length allowed.

    - -
    -

    Remarks

    The email form's "Description" attribute does not have the this method.

    -
-
- -
    - -
  • -

    Gets the logical name of the attribute.

    -
    -

    Returns string

    The logical name.

    - -
-
- -
    - -
  • -

    Gets a reference to the record context of this attribute.

    -
    -

    Returns Xrm.Entity

    The parent record context.

    - -
-
- -
-
- -
    - -
  • -

    Gets current submit mode for the attribute.

    -
    -

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    - -
    -

    Remarks

    The default value is "dirty"

    -
-
- -
-
- -
    - -
  • -

    Gets the value.

    -
    -

    Returns string

    The value.

    - -
-
- -
    - -
  • -

    Removes the handler from the "on change" event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a value for a column to determine whether it is valid or invalid with a message

    -
    -
    -

    Parameters

    -
      -
    • -
      isValid: boolean
      -

      Specify false to set the column value to invalid and true to set the value to valid.

      -
      -
    • -
    • -
      Optional message: string
      -

      The message to display.

      -
      -
    -

    Returns void

    -
-
- -
-
- -
    - -
  • -

    Sets the submit mode.

    -
    -
    -

    Parameters

    -
      -
    • -
      submitMode: Xrm.SubmitMode
      -

      The submit mode, as either "always", "never", or "dirty".

      -
      -
    -

    Returns void

    -
    -

    Default

    submitMode "dirty"
    -
    - -

    See

    AttributeRequirementLevel

    -
-
- -
    - -
  • -

    Sets the value.

    -
    -
    -

    Parameters

    -
      -
    • -
      value: string
      -

      The value.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    A String field with the email format enforces email - address formatting. Attributes on Quick Create Forms will not save values set - with this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StringControl.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.StringControl.html deleted file mode 100644 index 37e60d3..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.StringControl.html +++ /dev/null @@ -1,702 +0,0 @@ -StringControl | xrm-ex
-
- -
-
-
-
- -

Interface StringControl

-
-

Interface for a String control.

-
-
-

See

StandardControl

- -

Deprecated

Use StringControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an error or recommendation notification for a control, and lets you specify actions to execute based on the notification.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the keypress event so that the function is called when you type a character in the specific text or number field. -For a sample JavaScript code that uses the addOnKeyPress method to configure the auto-completion experience, see Sample: Auto-complete in CRM controls.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Adds an event handler to the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Clears the notification identified by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional uniqueId: string
      -

      (Optional) Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    If the uniqueId parameter is not used, the current notification shown will be removed.

    -
-
- -
    - -
  • -

    Use this to manually fire an event handler that you created for a specific text or number field to be executed on the keypress event.

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
    - -
  • -

    Returns a dictionary of the output properties of the control.

    -
    -

    Returns {
        [index: string]: FieldControlOutput;
    }

    A dictionary for the output parameters from the control. - For a PCF control this is of the pattern .fieldControl., e.g. telephone1.fieldControl.isValid

    - - -
-
- -
-
- -
    - -
  • -

    Gets the latest value in a control as the user types characters in a specific text or number field. -This method helps you to build interactive experiences by validating data and alerting users as they type characters in a control. -The getValue method is different from the attribute getValue method because the control method retrieves the value from the control -as the user is typing in the control as opposed to the attribute getValue method that retrieves the value after the user commits (saves) the field.

    -
    -

    Returns string

    -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
-
- -
    - -
  • -

    Use this to remove an event handler for a text or number field that you added using addOnKeyPress.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs -Remarks: If an anonymous function is set using addOnKeyPress, it can’t be removed using this method.

    -
-
- -
    - -
  • -

    Removes an event handler from the OnOutputChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a control-local notification message.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    true if it succeeds, false if it fails.

    - -
    -

    Remarks

    When this method is used on Microsoft Dynamics CRM for tablets a red "X" icon - appears next to the control. Tapping on the icon will display the message.

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Shows upt to 10 matching strings in a drop-down list as users press keys to type charactrer in a specific text field. -On selecting an item in the drop-down list, the value in the text field changes to the selected item, the drop-down list disappears, and the OnChange event for the text field is invoked

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Tab.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.Tab.html deleted file mode 100644 index 9fdae71..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.Tab.html +++ /dev/null @@ -1,441 +0,0 @@ -Tab | xrm-ex
-
- -
-
-
-
- -

Interface Tab

-
-

Interface for a form tab.

-
-
-

See

- -

Deprecated

Use Tab instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- - -

A reference to the collection of form sections within this tab.

-
-
-
-

Methods

-
- -
    - -
  • -

    Adds a function to be called when the TabStateChange event occurs.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Gets display state of the tab.

    -
    -

    Returns Xrm.DisplayState

    The display state, as either "expanded" or "collapsed"

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the tab.

    -
    -

    Returns string

    The name.

    - -
-
- -
    - -
  • -

    Gets a reference to the formContext.ui parent of the tab.

    -
    -

    Returns Ui

    The parent.

    - -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Removes a function to be called when the TabStateChange event occurs.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets display state of the tab.

    -
    -
    -

    Parameters

    -
      -
    • -
      displayState: Xrm.DisplayState
      -

      Display state of the tab, as either "expanded" or "collapsed"

      -
      -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in the 2021 release wave 1 (April 2021). Use the setFocus method in Unified Interface to ensure the correct tab is opened on a form.

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.TimelineWall.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.TimelineWall.html deleted file mode 100644 index 37d329f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.TimelineWall.html +++ /dev/null @@ -1,356 +0,0 @@ -TimelineWall | xrm-ex
-
- -
-
-
-
- -

Interface TimelineWall

-
-

Interface for a Timeline control.

-
-
-

See

Control

- -

Deprecated

Use TimelineWall instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns string

    The control type.

    -Values returned are:

    -
      -
    • standard
    • -
    • iframe
    • -
    • lookup
    • -
    • optionset
    • -
    • subgrid
    • -
    • webresource
    • -
    • notes
    • -
    • timercontrol
    • -
    • kbsearch
    • -
    • quickform (see ui.QuickForm)
    • -
    • customcontrol: . (A custom control for mobile phone and tablet clients).
    • -
    • customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
    • -
    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Refreshes the data displayed in a timelinewall and timer control.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiCanGetVisibleElement.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiCanGetVisibleElement.html deleted file mode 100644 index fa34cd1..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiCanGetVisibleElement.html +++ /dev/null @@ -1,232 +0,0 @@ -UiCanGetVisibleElement | xrm-ex
-
- -
-
-
-
- -

Interface UiCanGetVisibleElement

-
-

Interface for UI elements which can have the visibility value read.

-
-
-

Deprecated

Use UiCanGetVisibleElement instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiCanSetVisibleElement.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiCanSetVisibleElement.html deleted file mode 100644 index c858ab6..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiCanSetVisibleElement.html +++ /dev/null @@ -1,239 +0,0 @@ -UiCanSetVisibleElement | xrm-ex
-
- -
-
-
-
- -

Interface UiCanSetVisibleElement

-
-

Interface for UI elements which can have the visibility value updated.

-
-
-

Deprecated

Use UiCanSetVisibleElement instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiFocusable.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiFocusable.html deleted file mode 100644 index 3d7a860..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiFocusable.html +++ /dev/null @@ -1,231 +0,0 @@ -UiFocusable | xrm-ex
-
- -
-
-
-
- -

Interface UiFocusable

-
-

Interface for focusable UI elements.

-
-
-

Deprecated

Use UiFocusable instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiKeyPressable.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiKeyPressable.html deleted file mode 100644 index c4490c7..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiKeyPressable.html +++ /dev/null @@ -1,290 +0,0 @@ -UiKeyPressable | xrm-ex
-
- -
-
-
-
- -

Interface UiKeyPressable

-
-

Interface for controls which methods provide immediate feedback or take actions as user types in a control. -Contains methods which can be used to perform data validations in a control even before the user commits (saves) the value in a form.

-
-
-

Deprecated

Use UiKeyPressable instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Use this to add a function as an event handler for the keypress event so that the function is called when you type a character in the specific text or number field. -For a sample JavaScript code that uses the addOnKeyPress method to configure the auto-completion experience, see Sample: Auto-complete in CRM controls.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Use this to manually fire an event handler that you created for a specific text or number field to be executed on the keypress event.

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Use this to remove an event handler for a text or number field that you added using addOnKeyPress.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9.1; Use a custom control.

    - -

    See

    External Link: Deprecated Client APIs -Remarks: If an anonymous function is set using addOnKeyPress, it can’t be removed using this method.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiLabelElement.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiLabelElement.html deleted file mode 100644 index 3854f3a..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiLabelElement.html +++ /dev/null @@ -1,254 +0,0 @@ -UiLabelElement | xrm-ex
-
- -
-
-
-
- -

Interface UiLabelElement

-
-

Interface for UI elements with labels.

-
-
-

Deprecated

Use UiLabelElement instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiStandardElement.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiStandardElement.html deleted file mode 100644 index eeaae21..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.UiStandardElement.html +++ /dev/null @@ -1,291 +0,0 @@ -UiStandardElement | xrm-ex
-
- -
-
-
-
- -

Interface UiStandardElement

-
-

Base interface for standard UI elements.

-
-
-

Deprecated

Use UiStandardElement instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.data.ProcessDictionary.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.data.ProcessDictionary.html deleted file mode 100644 index 7591e08..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.data.ProcessDictionary.html +++ /dev/null @@ -1,213 +0,0 @@ -ProcessDictionary | xrm-ex
-
- -
-
-
-
- -

Interface ProcessDictionary

-
-

Represents a key-value pair, where the key is the Process Flow's ID, and the value is the name thereof.

-
-
-

Deprecated

Use ProcessDictionary instead.

-
-
-

Hierarchy

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.data.ProcessManager.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.data.ProcessManager.html deleted file mode 100644 index 19a7524..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.data.ProcessManager.html +++ /dev/null @@ -1,808 +0,0 @@ -ProcessManager | xrm-ex
-
- -
-
-
-
- -

Interface ProcessManager

-
-

Interface for the Xrm.Page.data.process API.

-
-
-

Deprecated

Use ProcessManager instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnPreProcessStatusChange event so that it will be called before the -business process flow status changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: Xrm.Events.ProcessStatusChangeHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnPreStageChange event so that it will be called before the -business process flow stage changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnPreProcessStatusChange event so that it will be called when the -business process flow status changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: Xrm.Events.ProcessStatusChangeHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnStageChange event so that it will be called when the -business process flow stage changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnStageSelected event so that it will be called -when a business process flow stage is selected.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: Xrm.Events.ContextSensitiveHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this method to get a collection of stages currently in the active path with methods to interact with the -stages displayed in the business process flow control. The active path represents stages currently rendered in -the process control based on the branching rules and current data in the record.

    -
    -

    Returns ItemCollection<Xrm.ProcessFlow.Stage>

    A collection of all completed stages, the currently active stage, and the predicted set of future stages - based on satisfied conditions in the branching rule. This may be a subset of the stages returned with - formContext.data.process.getActiveProcess because it will only include those stages which represent a valid - transition from the current stage based on branching that has occurred in the process.

    - -
-
- -
-
- -
-
- -
    - -
  • -

    Use this method to asynchronously retrieve the enabled business process flows that the user can switch to for an -entity.

    -
    -
    -

    Parameters

    -
      -
    • -
      callbackFunction: ((enabledProcesses) => void)
      -

      The callback function must accept a parameter that contains an object with - dictionary properties where the name of the property is the 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 UI if they - want to change the process manually.

      -
      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this method to get the unique identifier of the process instance

    -
    -

    Returns string

    The unique identifier of the process instance

    - -
-
- -
    - -
  • -

    Use this method to get the name of the process instance

    -
    -

    Returns string

    The name of the process instance

    - -
-
- -
    - -
  • -

    Returns all process instances for the entity record that the calling user has access to.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
-
- -
-
- -
    - -
  • -

    Progresses to the next stage.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Moves to the previous stage.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnPreProcessStatusChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnPreStageChange event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      If an anonymous function is set using the addOnPreStageChange method it - cannot be removed using this method.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnProcessStatusChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnStageChange event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      If an anonymous function is set using the addOnStageChange method it - cannot be removed using this method.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnStageChange event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageSelectedEventHandler
      -

      If an anonymous function is set using the addOnStageChange method it - cannot be removed using this method.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Set a Process as the active process.

    -
    -
    -

    Parameters

    -
      -
    • -
      processId: string
      -

      The Id of the process to make the active process.

      -
      -
    • -
    • -
      Optional callbackFunction: Xrm.ProcessFlow.ProcessCallbackDelegate
      -

      (Optional) a function to call when the operation is complete.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a process instance as the active instance

    -
    -
    -

    Parameters

    -
      -
    • -
      processInstanceId: string
      -

      The Id of the process instance to make the active instance.

      -
      -
    • -
    • -
      Optional callbackFunction: Xrm.ProcessFlow.SetProcessInstanceDelegate
      -

      (Optional) a function to call when the operation is complete.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Set a stage as the active stage.

    -
    -
    -

    Parameters

    -
      -
    • -
      stageId: string
      -

      the Id of the stage to make the active stage.

      -
      -
    • -
    • -
      Optional callbackFunction: Xrm.ProcessFlow.ProcessCallbackDelegate
      -

      (Optional) a function to call when the operation is complete.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this method to set the current status of the process instance

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.Grid.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.Grid.html deleted file mode 100644 index 03c145e..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.Grid.html +++ /dev/null @@ -1,281 +0,0 @@ -Grid | xrm-ex
-
- -
-
-
-
- -

Interface Grid

-
-

Interface for a grid. Use Grid methods to access information about data in the grid. Grid is returned by the -GridControl.getGrid method.

-
-
-

Deprecated

Use Grid instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
-
- -
    - -
  • -

    Returns the total number of records in the Grid.

    -
    -

    Returns number

    The total record count.

    - -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridEntity.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridEntity.html deleted file mode 100644 index 3e0345d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridEntity.html +++ /dev/null @@ -1,303 +0,0 @@ -GridEntity | xrm-ex
-
- -
-
-
-
- -

Interface GridEntity

-
-

Interface for a grid entity. Use the GridEntity methods to access data about the specific records in the rows. -GridEntity is returned by the GridRowData.getEntity method.

-
-
-

Deprecated

Use GridRowData instead.v

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns the logical name for the record in the row.

    -
    -

    Returns string

    The entity name.

    - -
    -

    Deprecated

    Use GridRow.data.entity.getEntityName() instead.

    -
-
- -
    - -
  • -

    Returns a LookupValue that references this record.

    -
    -

    Returns Xrm.LookupValue

    The entity reference.

    - -
    -

    Deprecated

    Use GridRow.data.entity.getEntityReference() instead.

    -
-
- -
    - -
  • -

    Returns the id for the record in the row.

    -
    -

    Returns string

    The identifier of the GridEntity, in GUID format.

    - -
    -

    Example

    Example return: "{00000000-0000-0000-0000-000000000000}"
    -
    - -

    Deprecated

    Use GridRow.data.entity.getId() instead.

    -
-
- -
    - -
  • -

    Returns the primary attribute value for the record in the row. (Commonly the name.)

    -
    -

    Returns string

    The primary attribute value.

    - -
    -

    Deprecated

    Use GridRow.data.entity.getPrimaryAttributeValue() instead.

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridRow.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridRow.html deleted file mode 100644 index ab54929..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridRow.html +++ /dev/null @@ -1,266 +0,0 @@ -GridRow | xrm-ex
-
- -
-
-
-
- -

Interface GridRow

-
-

Interface for a grid row. Use the GridRow.getData method to access the GridRowData. A collection of GridRow is -returned by Grid.getRows and Grid.getSelectedRows methods. -In V9 - this is essentailly a form context.

-
-
-

Deprecated

Use GridRow instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
-
-

Properties

-
- -
data: Data
-

Provides methods to work with the row data.

-
-
-
-

Methods

-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridRowData.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridRowData.html deleted file mode 100644 index c9cea5f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.GridRowData.html +++ /dev/null @@ -1,249 +0,0 @@ -GridRowData | xrm-ex
-
- -
-
-
-
- -

Interface GridRowData

-
-

Interface for grid row data. Use the GridRowData.getEntity method to access the GridEntity. GridRowData is -returned by the GridRow.getData method.

-
-
-

Deprecated

Use GridRowData instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ProcessManager.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ProcessManager.html deleted file mode 100644 index 75e4a3d..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ProcessManager.html +++ /dev/null @@ -1,336 +0,0 @@ -ProcessManager | xrm-ex
-
- -
-
-
-
- -

Interface ProcessManager

-
-

Interface for Xrm.Page.ui.process API

-
-
-

Deprecated

Use ProcessControl instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Reflow the UI of the process control

    -
    -
    -

    Parameters

    -
      -
    • -
      updateUI: boolean
      -

      Specify true to update the UI of the process control; false otherwise.

      -
      -
    • -
    • -
      parentStage: string
      -

      ID of the parent stage.

      -
      -
    • -
    • -
      nextStage: string
      -

      ID of the next stage.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets display state of the process flow control.

    -
    -
    -

    Parameters

    -
      -
    • -
      displayState: Xrm.DisplayState
      -

      Display state of the process flow control, as either "expanded" or "collapsed"

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.QuickForm.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.QuickForm.html deleted file mode 100644 index f4b4fdc..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.QuickForm.html +++ /dev/null @@ -1,561 +0,0 @@ -QuickForm | xrm-ex
-
- -
-
-
-
- -

Interface QuickForm

-
-

Interface for a quick view control instance on a form.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Gets the constituent controls in a quick view control.

    -
    -

    Returns Xrm.Controls.Control[]

    An array of controls.

    - -
    -

    Remarks

    Constituent controls in a quick view control are read only.

    -
  • - -
  • -

    Gets the constituent controls in a quick view control.

    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      controlName: string
      -

      Name of the control.

      -
      -
    -

    Returns T

    The control.

    - -
    -

    Remarks

    Constituent controls in a quick view control are read only.

    -
  • - -
  • -

    Gets the constituent controls in a quick view control.

    -
    -
    -

    Parameters

    -
      -
    • -
      controlName: string
      -

      Name of the control.

      -
      -
    -

    Returns Xrm.Controls.Control

    The control.

    - -
    -

    Remarks

    Constituent controls in a quick view control are read only.

    -
  • - -
  • -

    Gets a control by index.

    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      index: number
      -

      The control index.

      -
      -
    -

    Returns T

    The control.

    - -
    -

    Remarks

    Constituent controls in a quick view control are read only.

    -
  • - -
  • -

    Gets a control by index.

    -
    -
    -

    Parameters

    -
      -
    • -
      index: number
      -

      The control index.

      -
      -
    -

    Returns Xrm.Controls.Control

    The control.

    - -
    -

    Remarks

    Constituent controls in a quick view control are read only.

    -
-
- -
    - -
  • -

    Gets the controls type.

    -
    -

    Returns "quickform"

    Returns a string value ("quickform") that categorizes quick view controls.

    - -
-
- -
    - -
  • -

    Gets a boolean value, indicating whether the control is disabled.

    -
    -

    Returns boolean

    true if it is disabled, otherwise false.

    - -
-
- -
    - -
  • -

    Gets the label.

    -
    -

    Returns string

    The label.

    - -
-
- -
    - -
  • -

    Gets the name of the control on the form.

    -
    -

    Returns string

    The name of the control.

    - -
    -

    Remarks

    The name assigned to a control is not determined until the form loads. Changes to - the form may change the name assigned to a given control. - When you use the control getName method the name of the first control will be the - same as the name of the attribute. The second instance of a control for that - attribute will be "1". The pattern +N - will continue for each additional control added to the form for a specific - attribute. When a form displays a business process flow control in the header, - additional controls will be added for each attribute that is displayed in the - business process flow. These controls have a unique name like the following: - header_process_.

    -
-
- -
-
- -
    - -
  • -

    Gets the visibility state.

    -
    -

    Returns boolean

    true if the tab is visible, otherwise false.

    - -
-
- -
    - -
  • -

    Returns whether the data binding for the constituent controls in a quick view control is complete.

    -
    -

    Returns boolean

    True is the data binding for a constituent control is complete, otherwise false. - because the quick view form that the control is bound to may not have loaded completely. - As a result, using the getAttribute or any data-related methods on a constituent control might not work. - The isLoaded method for the quick view control helps determine the data binding status for constituent controls in a quick view control.

    - -
    -

    Remarks

    The data binding for the constituent controls in a quick view control may not be complete during the main form OnLoad event

    -
-
- -
    - -
  • -

    Refreshes the data displayed in a quick view control.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the state of the control to either enabled, or disabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      disabled: boolean
      -

      true to disable, false to enable.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets focus on the element.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the label.

    -
    -
    -

    Parameters

    -
      -
    • -
      label: string
      -

      The label.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets the visibility state.

    -
    -
    -

    Parameters

    -
      -
    • -
      visible: boolean
      -

      true to show, false to hide.

      -
      -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ViewSelector.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ViewSelector.html deleted file mode 100644 index 59aa948..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ViewSelector.html +++ /dev/null @@ -1,284 +0,0 @@ -ViewSelector | xrm-ex
-
- -
-
-
-
- -

Interface ViewSelector

-
-

Interface for the view selector. Use the ViewSelector methods to get or set information about the view selector -of the grid control.

-
-
-

Deprecated

Use ViewSelector instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
-
- -
    - -
  • -

    Use this method to determine whether the view selector is visible.

    -
    -

    Returns boolean

    true if visible, false if not.

    - -
-
- -
    - -
  • -

    Use this method to set the current view.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ViewSelectorItem.html b/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ViewSelectorItem.html deleted file mode 100644 index b043001..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Page.ui.ViewSelectorItem.html +++ /dev/null @@ -1,247 +0,0 @@ -ViewSelectorItem | xrm-ex
-
- -
-
-
-
- -

Interface ViewSelectorItem

-
-

Interface for a view selector item. This object contains data that identifies a view. Use this as a parameter to -the ViewSelector.setCurrentView method.

-
-
-

Deprecated

Use ViewSelectorItem instead.

-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.PageContext.html b/docs/interfaces/node_modules__types_xrm.Xrm.PageContext.html deleted file mode 100644 index f400479..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.PageContext.html +++ /dev/null @@ -1,147 +0,0 @@ -PageContext | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Panel.html b/docs/interfaces/node_modules__types_xrm.Xrm.Panel.html deleted file mode 100644 index 19cdbee..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Panel.html +++ /dev/null @@ -1,170 +0,0 @@ -Panel | xrm-ex
-
- -
-
-
-
- -

Interface Panel

-
-

Interface for the Xrm.Panel API

-
-
-
-

Hierarchy

-
    -
  • Panel
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Displays the web page represented by a URL in the static area in the side pane, which appears on all pages in the Customer Engagement web client.

    -
    -
    -

    Parameters

    -
      -
    • -
      url: string
      -

      URL of the page to be loaded in the side pane static area.

      -
      -
    • -
    • -
      title: string
      -

      Title of the side pane static area.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    This method is only supported for the web client.

    - -

    See

    External Link: loadPanel (Client-side reference)

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Privilege.html b/docs/interfaces/node_modules__types_xrm.Xrm.Privilege.html deleted file mode 100644 index 81dc9e2..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Privilege.html +++ /dev/null @@ -1,170 +0,0 @@ -Privilege | xrm-ex
-
- -
-
-
-
- -

Interface Privilege

-
-

Interface for a user attribute privilege.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
canCreate: boolean
-

True if the user can create.

-
-
-
- -
canRead: boolean
-

True if the user can read.

-
-
-
- -
canUpdate: boolean
-

True if the user can update.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Process.html b/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Process.html deleted file mode 100644 index 5931e9f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Process.html +++ /dev/null @@ -1,217 +0,0 @@ -Process | xrm-ex
-
- -
-
-
- -
-

Interface for a CRM Business Process Flow instance.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
-
-

Methods

-
- -
    - -
  • -

    Returns the unique identifier of the process.

    -
    -

    Returns string

    The identifier for this process, in GUID format.

    - -
    -

    Example

    Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}".
    -
    -
-
- -
    - -
  • -

    Returns the name of the process.

    -
    -

    Returns string

    The name.

    - -
-
- -
-
- -
    - -
  • -

    Returns a boolean value to indicate if the process is rendered.

    -
    -

    Returns boolean

    true if the process is rendered, false if not.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.ProcessDictionary.html b/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.ProcessDictionary.html deleted file mode 100644 index 77632f1..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.ProcessDictionary.html +++ /dev/null @@ -1,145 +0,0 @@ -ProcessDictionary | xrm-ex
-
- -
-
-
-
- -

Interface ProcessDictionary

-
-

Represents a key-value pair, where the key is the Process Flow's ID, and the value is the name thereof.

-
-
-
-

Hierarchy

-
-
-

Indexable

-
[index: string]: string
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.ProcessManager.html b/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.ProcessManager.html deleted file mode 100644 index 0dda134..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.ProcessManager.html +++ /dev/null @@ -1,714 +0,0 @@ -ProcessManager | xrm-ex
-
- -
-
-
-
- -

Interface ProcessManager

-
-

Interface for the formContext.data.process API.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnPreProcessStatusChange event so that it will be called before the -business process flow status changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: Xrm.Events.ProcessStatusChangeHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnPreStageChange event so that it will be called before the -business process flow stage changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnPreProcessStatusChange event so that it will be called when the -business process flow status changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: Xrm.Events.ProcessStatusChangeHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnStageChange event so that it will be called when the -business process flow stage changes.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to add a function as an event handler for the OnStageSelected event so that it will be called -when a business process flow stage is selected.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: Xrm.Events.ContextSensitiveHandler
      -

      The function will be added to the bottom of the event - handler pipeline. The execution context is automatically - set to be the first parameter passed to the event handler. - Use a reference to a named function rather than an - anonymous function if you may later want to remove the - event handler.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this method to get a collection of stages currently in the active path with methods to interact with the -stages displayed in the business process flow control. The active path represents stages currently rendered in -the process control based on the branching rules and current data in the record.

    -
    -

    Returns ItemCollection<Xrm.ProcessFlow.Stage>

    A collection of all completed stages, the currently active stage, and the predicted set of future stages - based on satisfied conditions in the branching rule. This may be a subset of the stages returned with - formContext.data.process.getActiveProcess because it will only include those stages which represent a valid - transition from the current stage based on branching that has occurred in the process.

    - -
-
- -
    - -
  • -

    Returns a Process object representing the active process.

    -
    -

    Returns Xrm.ProcessFlow.Process

    current active process.

    - -
-
- -
    - -
  • -

    Returns a Stage object representing the active stage.

    -
    -

    Returns Xrm.ProcessFlow.Stage

    current active stage.

    - -
-
- -
    - -
  • -

    Use this method to asynchronously retrieve the enabled business process flows that the user can switch to for an -entity.

    -
    -
    -

    Parameters

    -
      -
    • -
      callbackFunction: ((enabledProcesses) => void)
      -

      The callback function must accept a parameter that contains an object with - dictionary properties where the name of the property is the 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 UI if they - want to change the process manually.

      -
      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this method to get the unique identifier of the process instance

    -
    -

    Returns string

    The unique identifier of the process instance

    - -
-
- -
    - -
  • -

    Use this method to get the name of the process instance

    -
    -

    Returns string

    The name of the process instance

    - -
-
- -
    - -
  • -

    Returns all process instances for the entity record that the calling user has access to.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this method to get the currently selected stage.

    -
    -

    Returns Xrm.ProcessFlow.Stage

    The currently selected stage.

    - -
-
- -
-
- -
    - -
  • -

    Progresses to the next stage.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Moves to the previous stage.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnPreProcessStatusChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnPreStageChange event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      If an anonymous function is set using the addOnPreStageChange method it - cannot be removed using this method.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnProcessStatusChange event.

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnStageChange event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageChangeEventHandler
      -

      If an anonymous function is set using the addOnStageChange method it - cannot be removed using this method.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this to remove a function as an event handler for the OnStageChange event.

    -
    -
    -

    Parameters

    -
      -
    • -
      handler: StageSelectedEventHandler
      -

      If an anonymous function is set using the addOnStageChange method it - cannot be removed using this method.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Set a Process as the active process.

    -
    -
    -

    Parameters

    -
      -
    • -
      processId: string
      -

      The Id of the process to make the active process.

      -
      -
    • -
    • -
      Optional callbackFunction: Xrm.ProcessFlow.ProcessCallbackDelegate
      -

      (Optional) a function to call when the operation is complete.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Sets a process instance as the active instance

    -
    -
    -

    Parameters

    -
      -
    • -
      processInstanceId: string
      -

      The Id of the process instance to make the active instance.

      -
      -
    • -
    • -
      Optional callbackFunction: Xrm.ProcessFlow.SetProcessInstanceDelegate
      -

      (Optional) a function to call when the operation is complete.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Set a stage as the active stage.

    -
    -
    -

    Parameters

    -
      -
    • -
      stageId: string
      -

      the Id of the stage to make the active stage.

      -
      -
    • -
    • -
      Optional callbackFunction: Xrm.ProcessFlow.ProcessCallbackDelegate
      -

      (Optional) a function to call when the operation is complete.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Use this method to set the current status of the process instance

    -
    -
    -

    Parameters

    -
    -

    Returns void

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Stage.html b/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Stage.html deleted file mode 100644 index 5197369..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Stage.html +++ /dev/null @@ -1,253 +0,0 @@ -Stage | xrm-ex
-
- -
-
-
- -
-

Interface for CRM Business Process Flow stages.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns an object with a getValue method which will return the integer value of the business process flow -category.

    -
    -

    Returns {
        getValue() => StageCategory;
    }

    The stage category.

    - - -
-
- -
    - -
  • -

    Returns the logical name of the entity associated with the stage.

    -
    -

    Returns string

    The entity name.

    - -
-
- -
    - -
  • -

    Returns the unique identifier of the stage.

    -
    -

    Returns string

    The identifier of the Stage, in GUID format.

    - -
    -

    Example

    Example: "{825CB223-A651-DF11-AA8B-00155DBA3804}".
    -
    -
-
- -
    - -
  • -

    Returns the name of the stage.

    -
    -

    Returns string

    The name.

    - -
-
- -
-
- -
    - -
  • -

    Returns a collection of steps in the stage.

    -
    -

    Returns Xrm.ProcessFlow.Step[]

    An array of Step.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Step.html b/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Step.html deleted file mode 100644 index 3d0fdd1..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.ProcessFlow.Step.html +++ /dev/null @@ -1,200 +0,0 @@ -Step | xrm-ex
-
- -
-
-
- -
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Returns the logical name of the attribute associated to the step.

    -
    -

    Returns string

    The attribute.

    - -
    -

    Remarks

    Some steps don’t contain an attribute value.

    -
-
- -
    - -
  • -

    Returns the name of the step.

    -
    -

    Returns string

    The name.

    - -
-
- -
    - -
  • -

    Returns whether the step is required in the business process flow.

    -
    -

    Returns boolean

    true if required, false if not.

    - -
    -

    Remarks

    Returns true if the step is marked as required in the Business Process Flow editor; otherwise, false. - There is no connection between this value and the values you can change in the formContext.data.entity - attribute RequiredLevel methods.

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.RetrieveMultipleResult.html b/docs/interfaces/node_modules__types_xrm.Xrm.RetrieveMultipleResult.html deleted file mode 100644 index 1559e83..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.RetrieveMultipleResult.html +++ /dev/null @@ -1,158 +0,0 @@ -RetrieveMultipleResult | xrm-ex
-
- -
-
-
-
- -

Interface RetrieveMultipleResult

-
-

Interface for the WebAPI RetrieveMultiple request response

-
-
-
-

Hierarchy

-
    -
  • RetrieveMultipleResult
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
entities: any[]
-

An array of JSON objects, where each object represents the retrieved entity record containing attributes and their values as key: value pairs. The Id of the entity record is retrieved by default.

-
-
-
- -
nextLink: string
-

If the number of records being retrieved is more than the value specified in the maxPageSize parameter, this attribute returns the URL to return next set of records.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.SaveOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.SaveOptions.html deleted file mode 100644 index a60b4f4..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.SaveOptions.html +++ /dev/null @@ -1,165 +0,0 @@ -SaveOptions | xrm-ex
-
- -
-
-
-
- -

Interface SaveOptions

-
-

Defines save options for saving the record.

-
-
-
-

Hierarchy

-
    -
  • SaveOptions
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
UseSchedulingEngine?: boolean
-

Indicates whether to use the Book or Reschedule messages rather than the Create or Update messages. -Applicable to appointment, recurring appointment, or service activity records.

-
-
-

Remarks

This property is not supported in Unified Interface.

-
-
- -
saveMode: XrmEnum.SaveMode
-

Specify a value indicating how the save event was initiated.

-
-
-

Remarks

For a list of supported values, see the return value of the getSaveMode method.

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.TagValue.html b/docs/interfaces/node_modules__types_xrm.Xrm.TagValue.html deleted file mode 100644 index da2a908..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.TagValue.html +++ /dev/null @@ -1,183 +0,0 @@ -TagValue | xrm-ex
-
- -
-
-
-
- -

Interface TagValue

-
-

Interface for a (lookup) Tag value

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
entityType: string
-

Type of the entity.

-
-
-
- -
fieldName: string
-

The originating lookup column that raised the event.

-
-
-
- -
id: string
-

The identifier.

-
-
-
- -
name?: string
-

The name

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Ui.html b/docs/interfaces/node_modules__types_xrm.Xrm.Ui.html deleted file mode 100644 index 66227cd..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Ui.html +++ /dev/null @@ -1,454 +0,0 @@ -Ui | xrm-ex
-
- -
-
-
-
- -

Interface Ui

-
-

Interface for the formContext.ui object.

-
-
-
-

Hierarchy

-
    -
  • Ui
-
-
-
- -
-
-

Properties

-
- - -

A reference to the collection of controls on the form.

-
-
-
- -
footerSection: FooterSection
-

Provides information on how to set the visibility of footer section.

-
-
-
- -
formSelector: Xrm.Controls.FormSelector
-

The form selector API.

-
-
-

Remarks

This API does not exist with Microsoft Dynamics CRM for tablets.

-
-
- -
headerSection: HeaderSection
-

Provides information on how to set the visibility of header section.

-
-
-
- -
navigation: Xrm.Controls.Navigation
-

The navigation API.

-
-
-

Remarks

This API does not exist with Microsoft Dynamics CRM for tablets.

-
-
- - -

The business process flow API, used to interact with the business process flow control in a form.

-
-
-
- - -

A collection of all the quick view controls on a form using the new form rendering engine (also called "turbo forms").

-
-
-
- - -

A reference to the collection of tabs on the form.

-
-
-
-

Methods

-
- -
-
- -
    - -
  • -

    Clears the form notification described by uniqueId.

    -
    -
    -

    Parameters

    -
      -
    • -
      uniqueId: string
      -

      Unique identifier.

      -
      -
    -

    Returns boolean

    True if it succeeds, otherwise false.

    - -
-
- -
    - -
  • -

    Closes the form.

    -
    -

    Returns void

    -
-
- -
    - -
  • -

    Gets form type.

    -
    -

    Returns FormType

    The form type.

    - -
    -

    Remarks

    Values returned are:

    -
      -
    • 0 Undefined
    • -
    • 1 Create
    • -
    • 2 Update
    • -
    • 3 Read Only
    • -
    • 4 Disabled
    • -
    • 6 Bulk Edit
    • -
    • Deprecated values are 5 (Quick Create), and 11 (Read Optimized)
    • -
    -
-
- -
    - -
  • -

    Gets view port height.

    -
    -

    Returns number

    The view port height, in pixels.

    - -
    -

    Remarks

    This method does not work with Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Gets view port width.

    -
    -

    Returns number

    The view port width, in pixels.

    - -
    -

    Remarks

    This method does not work with Microsoft Dynamics CRM for tablets.

    -
-
- -
    - -
  • -

    Re-evaluates the ribbon's configured EnableRules.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional refreshAll: boolean
      -

      Indicates whether all the ribbon command bars on the current page are refreshed. If you specify false only the page-level ribbon command bar is refreshed. -If you do not specifiy this parameter, by default false is passed.

      -
      -
    -

    Returns void

    -
    -

    Remarks

    This method does not work with Microsoft Dynamics CRM for tablets.

    -
-
- -
-
- -
    - -
  • -

    Sets the name of the table to be displayed on the form.

    -
    -
    -

    Parameters

    -
      -
    • -
      name: string
      -

      Name of the table to be displayed on the form.

      -
      -
    -

    Returns void

    -
-
- -
    - -
  • -

    Displays a form level notification. Any number of notifications can be displayed and will remain until removed using clearFormNotification. -The height of the notification area is limited so each new message will be added to the top.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The text of the notification message.

      -
      -
    • -
    • -
      level: Xrm.FormNotificationLevel
      -

      The level of the notification which defines how the message will be displayed, such as the icon. -ERROR: Notification will use the system error icon. -WARNING: Notification will use the system warning icon. -INFO: Notification will use the system info icon.

      -
      -
    • -
    • -
      uniqueId: string
      -

      Unique identifier for the notification which is used with clearFormNotification to remove the notification.

      -
      -
    -

    Returns boolean

    true if it succeeds, otherwise false.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Url.DialogOpenParameters.html b/docs/interfaces/node_modules__types_xrm.Xrm.Url.DialogOpenParameters.html deleted file mode 100644 index 85fabf3..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Url.DialogOpenParameters.html +++ /dev/null @@ -1,184 +0,0 @@ -DialogOpenParameters | xrm-ex
-
- -
-
-
-
- -

Interface DialogOpenParameters

-
-

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: -"&key=value".

-
-
-
-

Hierarchy

-
    -
  • DialogOpenParameters
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
DialogId: string
-

The unique identifier of the dialog, in Guid format, which is valid for the entity described -by: EntityName

-
-
-
- -
EntityName: string
-

The logical name of the entity.

-
-
-
- -
ObjectId: string
-

The unique identifier for the targeted record.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Url.FormOpenParameters.html b/docs/interfaces/node_modules__types_xrm.Xrm.Url.FormOpenParameters.html deleted file mode 100644 index de378ee..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Url.FormOpenParameters.html +++ /dev/null @@ -1,214 +0,0 @@ -FormOpenParameters | xrm-ex
-
- -
-
-
-
- -

Interface FormOpenParameters

-
-

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: -"&key=value".

-
-
-

See

External Link: Open forms, views, dialogs, and reports with a URL

- -

Remarks

A member for "pagetype" is not provided. The value "entityrecord" is required in - the URL, for forms. Example: "pagetype=entityrecord"

-
-
-

Hierarchy

-
    -
  • FormOpenParameters
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- - -

Controls whether the command bar is displayed.

-
-
-

Remarks

Accepted values are:

-
    -
  • "true" (The command bar is displayed.)
  • -
  • "false" (The command bar is not displayed.)
  • -
-
-
- -
etn: string
-

The logical name of the entity.

-
-
-
- -
extraqs?: string
-

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.

-
-
-

Example

Example:  encodeURIComponent("formid={8c9f3e6f-7839-e211-831e-00155db7d98f}");
-
-
-
- - -

Controls whether the Navigation bar is displayed on the form.

-
-
-

Remarks

Accepted values are:

-
    -
  • "on" (The navigation bar is displayed.)
  • -
  • "off" (The navigation bar is not displayed.)
  • -
  • "entity" (On an entity form, only the navigation options for related entities are available.)
  • -
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Url.ReportOpenParameters.html b/docs/interfaces/node_modules__types_xrm.Xrm.Url.ReportOpenParameters.html deleted file mode 100644 index 7932712..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Url.ReportOpenParameters.html +++ /dev/null @@ -1,190 +0,0 @@ -ReportOpenParameters | xrm-ex
-
- -
-
-
-
- -

Interface ReportOpenParameters

-
-

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"

-
-
-
-

Hierarchy

-
    -
  • ReportOpenParameters
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- - -

The action to perform, as either "run" or "filter".

-
-
-

Remarks

Actions:

-
    -
  • "run" Executes the report with default filters.
  • -
  • "filter" Presents the user with the filter editor, and a "Run Report" button.
  • -
-
-
- -
helpID?: string
-

The file name of the report. For out-of-box reports, this parameter enables context-sensitive -help.

-
-
-
- -
id: string
-

The unique identifier, held in the report's 'reportid' attribute, in Guid format.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Url.ViewOpenParameters.html b/docs/interfaces/node_modules__types_xrm.Xrm.Url.ViewOpenParameters.html deleted file mode 100644 index 9a9ce2f..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Url.ViewOpenParameters.html +++ /dev/null @@ -1,226 +0,0 @@ -ViewOpenParameters | xrm-ex
-
- -
-
-
-
- -

Interface ViewOpenParameters

-
-

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: -"&key=value".

-
-
-

See

External Link: Open forms, views, dialogs, and reports with a URL

- -

Remarks

A member for "pagetype" is not provided. The value "entitylist" is required in - the URL, for views. Example: "pagetype=entitylist"

-
-
-

Hierarchy

-
    -
  • ViewOpenParameters
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- - -

Controls whether the command bar is displayed.

-
-
-

Remarks

Accepted values are:

-
    -
  • "true" (The command bar is displayed.)
  • -
  • "false" (The command bar is not displayed.)
  • -
-
-
- -
etn: string
-

The logical name of the entity.

-
-
-
- - -

Controls whether the Navigation bar is displayed on the form.

-
-
-

Remarks

Accepted values are:

-
    -
  • "on" (The navigation bar is displayed.)
  • -
  • "off" (The navigation bar is not displayed.)
  • -
  • "entity" (On an entity form, only the navigation options for related entities are available.)
  • -
-
-
- -
viewid: string
-

The unique identifier of a view, in Guid format, which is valid for the entity described by -etn.

-
-
-
- -
viewtype: ViewType
-

The type of view identified by viewid.

-
-
-

Remarks

Accepted values are:

-
    -
  • 1039 System View
  • -
  • 4230 User View.
  • -
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.UserSettings.html b/docs/interfaces/node_modules__types_xrm.Xrm.UserSettings.html deleted file mode 100644 index b0c7723..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.UserSettings.html +++ /dev/null @@ -1,292 +0,0 @@ -UserSettings | xrm-ex
-
- -
-
-
-
- -

Interface UserSettings

-
-

Holds information about the current user settings.

-
-
-
-

Hierarchy

-
    -
  • UserSettings
-
-
-
- -
-
-

Properties

-
- -
dateFormattingInfo: DateFormattingInfo
-

Returns the date formatting information for the current user.

-
-
-
- -
defaultDashboardId: string
-

Returns the ID of the default dashboard for the current user.

-
-
-
- -
isGuidedHelpEnabled: boolean
-

Indicates whether guided help is enabled for the current user.

-
-
-
- -
isHighContrastEnabled: boolean
-

Indicates whether high contrast is enabled for the current user.

-
-
-
- -
isRTL: boolean
-

Indicates whether the language for the current user is a right-to-left (RTL) language.

-
-
-
- -
languageId: number
-

Returns the language ID for the current user.

-
-
-
- - -

Returns a collection of lookup objects containing the GUID and display name of each of the security role or teams that the user is associated with.

-
-
-
- -
securityRolePrivileges: string[]
-

Returns an array of strings that represent the GUID values of each of the security role privilege that the user is associated with or any teams that the user is associated with.

-
-
-
- -
securityRoles: string[]
-

Returns an array of strings that represent the GUID values of each of the security role that the user is associated with or any teams that the user is associated with.

-
-
-

Deprecated

Deprecated in v9.1; use globalContext.userSettings.roles instead to display names of security roles or teams along with the ID.

- -

See

External Link: Deprecated Client APIs

-
-
- -
transactionCurrency: Xrm.LookupValue
-

Returns a lookup object containing the ID, display name, and entity type of the transaction currency for the current user.

-
-
-
- -
transactionCurrencyId: string
-

Returns the transaction currency ID for the current user.

-
-
-

Deprecated

Deprecated in v9.1; use globalContext.userSettings.transactionCurrency instead to display name along with the ID.

-
-
- -
userId: string
-

Returns the GUID of the SystemUser.Id value for the current user.

-
-
-
- -
userName: string
-

Returns the name of the current user.

-
-
-
-

Methods

-
- -
    - -
  • -

    Returns the difference in minutes between the local time and Coordinated Universal Time (UTC).

    -
    -

    Returns number

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Utility-1.html b/docs/interfaces/node_modules__types_xrm.Xrm.Utility-1.html deleted file mode 100644 index 1186a38..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Utility-1.html +++ /dev/null @@ -1,628 +0,0 @@ -Utility | xrm-ex
-
- -
-
-
-
- -

Interface Utility

-
-

Interface for the Xrm.Utility API

-
-
-
-

Hierarchy

-
    -
  • Utility
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Displays an alert dialog, with an "OK" button.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      onCloseCallback: (() => void)
      -

      The "OK" callback.

      -
      -
      -
        -
      • -
          -
        • (): void
        • -
        • -

          Returns void

    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9. Use openAlertDialog instead.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Displays a confirmation dialog, with "OK" and "Cancel" buttons.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message.

      -
      -
    • -
    • -
      yesCloseCallback: (() => void)
      -

      The "OK" callback.

      -
      -
      -
        -
      • -
          -
        • (): void
        • -
        • -

          Returns void

    • -
    • -
      noCloseCallback: (() => void)
      -

      The "Cancel" callback.

      -
      -
      -
        -
      • -
          -
        • (): void
        • -
        • -

          Returns void

    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9. Use openConfirmDialog instead.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Returns the valid state transitions for the specified entity type and state code.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityName: string
      -

      The logical name of the entity.

      -
      -
    • -
    • -
      stateCode: number
      -

      The state code to find out the allowed status transition values.

      -
      -
    -

    Returns PromiseLike<number[]>

    Returns an object with .then() function. The parameter to the delegate is an array of numbers representing the valid status transitions.

    - -
-
- -
    - -
  • -

    Returns the entity metadata for the specified entity.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityName: string
      -

      The logical name of the entity.

      -
      -
    • -
    • -
      Optional attributes: string[]
      -

      The attributes to get metadata for.

      -
      -
    -

    Returns PromiseLike<EntityMetadata>

    -
-
- -
-
- -
    - -
  • -

    Returns the name of the DOM attribute expected by the Learning Path (guided help) Content Designer for identifying UI controls in the model-driven apps forms. -An attribute by this name must be added to the UI element that needs to be exposed to Learning Path (guided help).

    -
    -

    Returns string

    DOM attribute expected by the Learning Path (guided help) Content Designer.

    - -
-
- -
    - -
  • -

    Gets the page context as an object representing the page.

    -
    -

    Returns PageContext

    The method returns an object with the input property. The input property is an object with the following attributes depending on whether you are currently on the entity form or entity list

    - -
-
- -
    - -
  • -

    Returns the localized string for a given key associated with the specified web resource.

    -
    -
    -

    Parameters

    -
      -
    • -
      webResourceName: string
      -

      The name of the web resource.

      -
      -
    • -
    • -
      key: string
      -

      The key for the localized string.

      -
      -
    -

    Returns string

    A localized string.

    - -
-
- -
-
- -
    - -
  • -

    Query if 'entityType' is an Activity entity.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityType: string
      -

      Type of the entity.

      -
      -
    -

    Returns boolean

    true if the entity is an Activity, false if not.

    - -
    -

    Deprecated

    Deprecated in v9. Use Xrm.Utility.getEntityMetadata(entityName, ["IsActivity"]) instead.

    - -

    Remarks

    The isActivityType method is synchronous so it was suitable for ribbon rules. -However, the replacement method, getEntityMetadata, is asynchronous, and is not suitable for ribbon rules.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
-
- -
    - -
  • -

    Opens an entity form.

    -
    -
    -

    Parameters

    -
      -
    • -
      name: string
      -

      The entity's logical name.

      -
      -
    • -
    • -
      Optional id: string
      -

      (Optional) The unique identifier for the record.

      -
      -
    • -
    • -
      Optional parameters: Xrm.Utility.FormOpenParameters
      -

      (Optional) A dictionary object that passes extra query string parameters to the form.

      -
      -
    • -
    • -
      Optional windowOptions: WindowOptions
      -

      (Optional) Options for controlling the window.

      -
      -
    -

    Returns void

    -
    -

    Deprecated

    Deprecated in v9. Use openForm instead.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Opens quick create.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The logical name of the entity to create.

      -
      -
    • -
    • -
      Optional createFromEntity: Xrm.LookupValue
      -

      (Optional) Designates a record that will provide default values based on mapped attribute values.

      -
      -
    • -
    • -
      Optional parameters: OpenParameters
      -

      (Optional) A dictionary object that passes extra query string parameters to the form. Invalid query string parameters will cause an error.

      -
      -
    -

    Returns PromiseLike<OpenQuickCreateSuccessCallbackObject>

    Returns an asynchronous promise.

    - -
    -

    Deprecated

    Deprecated in v9. Use openForm instead with the option {useQuickCreateForm:true}.

    - -

    See

    External Link: Deprecated Client APIs

    -
-
- -
    - -
  • -

    Opens an HTML Web Resource in a new browser window.

    -
    -
    -

    Parameters

    -
      -
    • -
      webResourceName: string
      -

      Name of the HTML web resource. Can be used to pass URL parameters. See Remarks.

      -
      -
    • -
    • -
      Optional webResourceData: string
      -

      (Optional) Data to pass into the Web Resource's data parameter. It is advised to use encodeURIcomponent() to encode the value.

      -
      -
    • -
    • -
      Optional width: number
      -

      (Optional) The width of the new window.

      -
      -
    • -
    • -
      Optional height: number
      -

      (Optional) The height of the new window.

      -
      -
    -

    Returns Window

    A Window reference, containing the opened Web Resource.

    - -
    -

    Deprecated

    Deprecated in v9. Use openWebResource instead.

    - -

    See

    External Link: Deprecated Client APIs

    - -

    Remarks

    This function will not work with Microsoft Dynamics CRM for tablets.
    -Valid WebResource URL Parameters:

    -
      -
    • typename
    • -
    • type
    • -
    • id
    • -
    • orgname
    • -
    • userlcid
    • -
    • data (identical to this method's webResourceData parameter)
    • -
    • formid
    • -
    -
-
- -
-
- -
    - -
  • -

    Displays a progress dialog with the specified message. -Any subsequent call to this method will update the displayed message in the existing progress dialog with the message specified in the latest method call.

    -
    -
    -

    Parameters

    -
      -
    • -
      message: string
      -

      The message to be displayed in the progress dialog.

      -
      -
    -

    Returns void

    -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Utility.FormOpenParameters.html b/docs/interfaces/node_modules__types_xrm.Xrm.Utility.FormOpenParameters.html deleted file mode 100644 index ce8d898..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Utility.FormOpenParameters.html +++ /dev/null @@ -1,190 +0,0 @@ -FormOpenParameters | xrm-ex
-
- -
-
-
-
- -

Interface FormOpenParameters

-
-

Interface for defining parameters on a Xrm.Utility.openEntityForm() request.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- - -

Controls whether the command bar is displayed.

-
-
-

Remarks

Accepted values are:

-
    -
  • "true" (The command bar is displayed.)
  • -
  • "false" (The command bar is not displayed.)
  • -
-
-
- -
formid?: string
-

The identifier of the form to use, when several are available.

-
-
-
- - -

Controls whether the Navigation bar is displayed on the form.

-
-
-

Remarks

Accepted values are:

-
    -
  • "on" (The navigation bar is displayed.)
  • -
  • "off" (The navigation bar is not displayed.)
  • -
  • "entity" (On an entity form, only the navigation options for related entities are available.)
  • -
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Utility.OpenParameters.html b/docs/interfaces/node_modules__types_xrm.Xrm.Utility.OpenParameters.html deleted file mode 100644 index 78a5e2b..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Utility.OpenParameters.html +++ /dev/null @@ -1,136 +0,0 @@ -OpenParameters | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.Utility.WindowOptions.html b/docs/interfaces/node_modules__types_xrm.Xrm.Utility.WindowOptions.html deleted file mode 100644 index c4f3f69..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.Utility.WindowOptions.html +++ /dev/null @@ -1,155 +0,0 @@ -WindowOptions | xrm-ex
-
- -
-
-
-
- -

Interface WindowOptions

-
-

Interface for window options.

-
-
-
-

Hierarchy

-
    -
  • WindowOptions
-
-
-
- -
-
-

Properties

-
-
-

Properties

-
- -
openInNewWindow: boolean
-

Direct the form to open in a new window.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.WebApi.html b/docs/interfaces/node_modules__types_xrm.Xrm.WebApi.html deleted file mode 100644 index fef434e..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.WebApi.html +++ /dev/null @@ -1,382 +0,0 @@ -WebApi | xrm-ex
-
- -
-
-
-
- -

Interface WebApi

-
-

Provides properties and methods to use Web API to create and manage records and execute Web API actions and functions in Customer Engagement.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
- -
offline: WebApiOffline
-

Provides methods to create and manage records in the Dynamics 365 Customer Engagement mobile clients while working in the offline mode.

-
-
-
- -
online: WebApiOnline
-

Provides methods to use Web API to create and manage records and execute Web API actions and functions in Customer Engagement when connected to the Customer Engagement server (online mode).

-
-
-
-

Methods

-
- -
    - -
  • -

    Creates an entity record

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      Logical name of the entity you want to create. For example: "account".

      -
      -
    • -
    • -
      record: any
      -

      A JSON object defining the attributes and values for the new entity record.

      -
      -
    -

    Returns PromiseLike<CreateResponse>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
- -
    - -
  • -

    Deletes an entity record.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the record you want to delete. For example: "account".

      -
      -
    • -
    • -
      id: string
      -

      GUID of the entity record you want to delete.

      -
      -
    -

    Returns PromiseLike<string>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
- -
    - -
  • -

    Returns a boolean value indicating whether an entity is offline enabled.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      Logical name of the entity. For example: "account".

      -
      -
    -

    Returns boolean

    true if the entity is offline enabled; otherwise false.

    - -
-
- -
    - -
  • -

    Retrieves a collection of entity records.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the records you want to retrieve. For example: "account".

      -
      -
    • -
    • -
      Optional options: string
      -

      (Optional) OData system query options or FetchXML query to retrieve your data.

      -
        -
      • Following system query options are supported: $select, $top, $filter, $expand, and $orderby.
      • -
      • To specify a FetchXML query, use the fetchXml attribute to specify the query.
      • -
      • NOTE: You must always use the $select system query option to limit the properties returned for an entity -record by including a comma-separated list of property names. This is an important performance best practice.
      • -
      • If properties aren’t specified using $select, all properties will be returned.
      • -
      • You can specify multiple system query options by using & to separate the query options.
      • -
      -
      -
    • -
    • -
      Optional maxPageSize: number
      -

      (Optional) Specify a positive number that indicates the number of entity records to be returned per page.

      -
        -
      • If you do not specify this parameter, the default value is passed as 5000. If the number of records being retrieved is more than the specified -maxPageSize value, nextLink attribute in the returned promise object will contain a link to retrieve the next set of entities.
      • -
      -
      -
    -

    Returns PromiseLike<RetrieveMultipleResult>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
- -
    - -
  • -

    Retrieves an entity record.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the record you want to retrieve. For example: "account".

      -
      -
    • -
    • -
      id: string
      -

      GUID of the entity record you want to retrieve.

      -
      -
    • -
    • -
      Optional options: string
      -

      (Optional) OData system query options, $select and $expand, to retrieve your data.

      -
        -
      • Use the $select system query option to limit the properties returned by including a comma-separated -list of property names. This is an important performance best practice. If properties aren’t -specified using $select, all properties will be returned.
      • -
      • Use the $expand system query option to control what data from related entities is returned. If you -just include the name of the navigation property, you’ll receive all the properties for related -records. You can limit the properties returned for related records using the $select system query -option in parentheses after the navigation property name. Use this for both single-valued and -collection-valued navigation properties.
      • -
      • You can also specify multiple query options by using & to separate the query options.
      • -
      -
      -
    -

    Returns PromiseLike<any>

    On success, returns a promise containing a JSON object with the retrieved attributes and their values.

    - -
    -

    Example

    options example:

    -
    options: $select=name&$expand=primarycontactid($select=contactid,fullname)
    -
    - -

    See

    External Link: retrieveRecord (Client API reference)

    -
-
- -
    - -
  • -

    Updates an entity record.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the record you want to update. For example: "account".

      -
      -
    • -
    • -
      id: string
      -

      GUID of the entity record you want to update.

      -
      -
    • -
    • -
      data: any
    -

    Returns PromiseLike<any>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.WebApiOffline.html b/docs/interfaces/node_modules__types_xrm.Xrm.WebApiOffline.html deleted file mode 100644 index b0c0a58..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.WebApiOffline.html +++ /dev/null @@ -1,327 +0,0 @@ -WebApiOffline | xrm-ex
-
- -
-
-
-
- -

Interface WebApiOffline

-
-

Interface for the Xrm.WebApi.offline API

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Creates an entity record

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      Logical name of the entity you want to create. For example: "account".

      -
      -
    • -
    • -
      record: any
      -

      A JSON object defining the attributes and values for the new entity record.

      -
      -
    -

    Returns PromiseLike<CreateResponse>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
- -
    - -
  • -

    Deletes an entity record.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the record you want to delete. For example: "account".

      -
      -
    • -
    • -
      id: string
      -

      GUID of the entity record you want to delete.

      -
      -
    -

    Returns PromiseLike<string>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
- -
    - -
  • -

    Retrieves a collection of entity records.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the records you want to retrieve. For example: "account".

      -
      -
    • -
    • -
      Optional options: string
      -

      (Optional) OData system query options or FetchXML query to retrieve your data.

      -
        -
      • Following system query options are supported: $select, $top, $filter, $expand, and $orderby.
      • -
      • To specify a FetchXML query, use the fetchXml attribute to specify the query.
      • -
      • NOTE: You must always use the $select system query option to limit the properties returned for an entity -record by including a comma-separated list of property names. This is an important performance best practice.
      • -
      • If properties aren’t specified using $select, all properties will be returned.
      • -
      • You can specify multiple system query options by using & to separate the query options.
      • -
      -
      -
    • -
    • -
      Optional maxPageSize: number
      -

      (Optional) Specify a positive number that indicates the number of entity records to be returned per page.

      -
        -
      • If you do not specify this parameter, the default value is passed as 5000. If the number of records being retrieved is more than the specified -maxPageSize value, nextLink attribute in the returned promise object will contain a link to retrieve the next set of entities.
      • -
      -
      -
    -

    Returns PromiseLike<RetrieveMultipleResult>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
- -
    - -
  • -

    Retrieves an entity record.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the record you want to retrieve. For example: "account".

      -
      -
    • -
    • -
      id: string
      -

      GUID of the entity record you want to retrieve.

      -
      -
    • -
    • -
      Optional options: string
      -

      (Optional) OData system query options, $select and $expand, to retrieve your data.

      -
        -
      • Use the $select system query option to limit the properties returned by including a comma-separated -list of property names. This is an important performance best practice. If properties aren’t -specified using $select, all properties will be returned.
      • -
      • Use the $expand system query option to control what data from related entities is returned. If you -just include the name of the navigation property, you’ll receive all the properties for related -records. You can limit the properties returned for related records using the $select system query -option in parentheses after the navigation property name. Use this for both single-valued and -collection-valued navigation properties.
      • -
      • You can also specify multiple query options by using & to separate the query options.
      • -
      -
      -
    -

    Returns PromiseLike<any>

    On success, returns a promise containing a JSON object with the retrieved attributes and their values.

    - -
    -

    Example

    options example:

    -
    options: $select=name&$expand=primarycontactid($select=contactid,fullname)
    -
    - -

    See

    External Link: retrieveRecord (Client API reference)

    -
-
- -
    - -
  • -

    Updates an entity record.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the record you want to update. For example: "account".

      -
      -
    • -
    • -
      id: string
      -

      GUID of the entity record you want to update.

      -
      -
    • -
    • -
      data: any
    -

    Returns PromiseLike<any>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.WebApiOnline.html b/docs/interfaces/node_modules__types_xrm.Xrm.WebApiOnline.html deleted file mode 100644 index c5b5b45..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.WebApiOnline.html +++ /dev/null @@ -1,413 +0,0 @@ -WebApiOnline | xrm-ex
-
- -
-
-
-
- -

Interface WebApiOnline

-
-

Interface for the online API -Execute and ExecuteMultiple are only available when online, not offline.

-
-
-
-

Hierarchy

-
-
-
-
- -
-
-

Methods

-
- -
    - -
  • -

    Creates an entity record

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      Logical name of the entity you want to create. For example: "account".

      -
      -
    • -
    • -
      record: any
      -

      A JSON object defining the attributes and values for the new entity record.

      -
      -
    -

    Returns PromiseLike<CreateResponse>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
- -
    - -
  • -

    Deletes an entity record.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the record you want to delete. For example: "account".

      -
      -
    • -
    • -
      id: string
      -

      GUID of the entity record you want to delete.

      -
      -
    -

    Returns PromiseLike<string>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
- -
    - -
  • -

    Execute a single action, function, or CRUD operation.

    -
    -
    -

    Parameters

    -
      -
    • -
      request: any
      -

      Object that will be passed to the Web API endpoint to execute an action, function, or CRUD request.

      -
      -
    -

    Returns PromiseLike<ExecuteResponse>

    -
    -

    See

    External Link: Xrm.WebApi.online.execute (Client API reference)

    - -

    Remarks

    The object exposes a getMetadata method that lets you define the metadata for the action, function or CRUD request you want to execute.
    -The getMetadata method has the following parameters:

    -
      -
    • boundParameter: (Optional) String. The name of the bound parameter for the action or function to execute.
        -
      • Specify undefined if you are executing a CRUD request.
      • -
      • Specify null if the action or function to execute is not bound to any entity.
      • -
      • Specify entity logical name or entity set name in case the action or function to execute is bound to one.
      • -
      -
    • -
    • operationName: (Optional). String. Name of the action, function, or one of the following values if you are executing a CRUD request: "Create", "Retrieve", "RetrieveMultiple", "Update", or "Delete".
    • -
    • operationType: (Optional). Number. Indicates the type of operation you are executing; specify one of the following values:
        -
      • 0: Action
      • -
      • 1: Function
      • -
      • 2: CRUD
      • -
      -
    • -
    • parameterTypes: Object. The metadata for parameter types. The object has the following attributes:
    • -
    • enumProperties: (Optional) Object. The metadata for enum types. The object has two string attributes: name and value
    • -
    • structuralProperty: Number. The category of the parameter type. Specify one of the following values:
        -
      • 0: Unknown
      • -
      • 1: PrimitiveType
      • -
      • 2: ComplexType
      • -
      • 3: EnumerationType
      • -
      • 4: Collection
      • -
      • 5: EntityType
      • -
      -
    • -
    • typeName: String. The fully qualified name of the parameter type.
    • -
    -
-
- -
    - -
  • -

    Execute a collection of action, function, or CRUD operations.

    -
    -
    -

    Parameters

    -
      -
    • -
      request: any[]
      -

      An array of one of one of the following types: - -objects where each object is an action, function, or CRUD request that you want to execute - * against the Web API endpoint. Each object exposes a getMetadata method that lets you define - the metadata for the action, function or CRUD request you want to execute. This is the same - object that you pass in the execute method. For information about the object, see execute. - -change set (an array of objects), where each object in the change set is as defined above. - * In this case, all the request objects specified in the change set will get executed in a - transaction.

      -
      -
    -

    Returns PromiseLike<ExecuteResponse[]>

    -
-
- -
    - -
  • -

    Retrieves a collection of entity records.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the records you want to retrieve. For example: "account".

      -
      -
    • -
    • -
      Optional options: string
      -

      (Optional) OData system query options or FetchXML query to retrieve your data.

      -
        -
      • Following system query options are supported: $select, $top, $filter, $expand, and $orderby.
      • -
      • To specify a FetchXML query, use the fetchXml attribute to specify the query.
      • -
      • NOTE: You must always use the $select system query option to limit the properties returned for an entity -record by including a comma-separated list of property names. This is an important performance best practice.
      • -
      • If properties aren’t specified using $select, all properties will be returned.
      • -
      • You can specify multiple system query options by using & to separate the query options.
      • -
      -
      -
    • -
    • -
      Optional maxPageSize: number
      -

      (Optional) Specify a positive number that indicates the number of entity records to be returned per page.

      -
        -
      • If you do not specify this parameter, the default value is passed as 5000. If the number of records being retrieved is more than the specified -maxPageSize value, nextLink attribute in the returned promise object will contain a link to retrieve the next set of entities.
      • -
      -
      -
    -

    Returns PromiseLike<RetrieveMultipleResult>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
- -
    - -
  • -

    Retrieves an entity record.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the record you want to retrieve. For example: "account".

      -
      -
    • -
    • -
      id: string
      -

      GUID of the entity record you want to retrieve.

      -
      -
    • -
    • -
      Optional options: string
      -

      (Optional) OData system query options, $select and $expand, to retrieve your data.

      -
        -
      • Use the $select system query option to limit the properties returned by including a comma-separated -list of property names. This is an important performance best practice. If properties aren’t -specified using $select, all properties will be returned.
      • -
      • Use the $expand system query option to control what data from related entities is returned. If you -just include the name of the navigation property, you’ll receive all the properties for related -records. You can limit the properties returned for related records using the $select system query -option in parentheses after the navigation property name. Use this for both single-valued and -collection-valued navigation properties.
      • -
      • You can also specify multiple query options by using & to separate the query options.
      • -
      -
      -
    -

    Returns PromiseLike<any>

    On success, returns a promise containing a JSON object with the retrieved attributes and their values.

    - -
    -

    Example

    options example:

    -
    options: $select=name&$expand=primarycontactid($select=contactid,fullname)
    -
    - -

    See

    External Link: retrieveRecord (Client API reference)

    -
-
- -
    - -
  • -

    Updates an entity record.

    -
    -
    -

    Parameters

    -
      -
    • -
      entityLogicalName: string
      -

      The entity logical name of the record you want to update. For example: "account".

      -
      -
    • -
    • -
      id: string
      -

      GUID of the entity record you want to update.

      -
      -
    • -
    • -
      data: any
    -

    Returns PromiseLike<any>

    On success, returns a promise object containing the attributes specified earlier in the description of the successCallback parameter.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/node_modules__types_xrm.Xrm.XrmStatic.html b/docs/interfaces/node_modules__types_xrm.Xrm.XrmStatic.html deleted file mode 100644 index 66b7e02..0000000 --- a/docs/interfaces/node_modules__types_xrm.Xrm.XrmStatic.html +++ /dev/null @@ -1,250 +0,0 @@ -XrmStatic | xrm-ex
-
- -
-
-
-
- -

Interface XrmStatic

-
-

Static xRM object.

-
-
-
-

Hierarchy

-
    -
  • XrmStatic
-
-
-
- -
-
-

Properties

-
- -
App: App
-

Provides app-related methods.

-
-
-
- -
Device: Device
-

Provides methods to use native device capabilities of mobile devices.

-
-
-
- -
Encoding: Encoding
-

Provides methods to encode strings.

-
-
-
- -
Mobile: Mobile
-

Provides methods to create and manage records in the mobile clients (for phones tablets).

-
-
-

Deprecated

Use WebApi instead.

-
-
- -
Navigation: Xrm.Navigation
-

Provides navigation-related methods.

-
-
-
- -
Page: Page
-

Provides a namespace container for the context, data and ui objects.

-
-
-

Deprecated

Deprecated in v9.

- -

See

External Link: Deprecated Client APIs

-
-
- -
Panel: Panel
-

Provides a method to display a web page in the side pane of the Customer Engagement form.

-
-
-
- -
Utility: Utility
-

Provides a container for useful functions not directly related to the current page.

-
-
-
- -
WebApi: WebApi
-

Provides properties and methods to use Web API to create and manage records and execute Web API actions and functions in Customer Engagement.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.App.html b/docs/modules/node_modules__types_xrm.Xrm.App.html deleted file mode 100644 index cb3b3b1..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.App.html +++ /dev/null @@ -1,140 +0,0 @@ -App | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Async.html b/docs/modules/node_modules__types_xrm.Xrm.Async.html deleted file mode 100644 index 7402bb4..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Async.html +++ /dev/null @@ -1,139 +0,0 @@ -Async | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Attributes.html b/docs/modules/node_modules__types_xrm.Xrm.Attributes.html deleted file mode 100644 index d7afcd7..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Attributes.html +++ /dev/null @@ -1,169 +0,0 @@ -Attributes | xrm-ex
-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Collection.html b/docs/modules/node_modules__types_xrm.Xrm.Collection.html deleted file mode 100644 index 408f4c9..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Collection.html +++ /dev/null @@ -1,142 +0,0 @@ -Collection | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Controls.Grid.html b/docs/modules/node_modules__types_xrm.Xrm.Controls.Grid.html deleted file mode 100644 index 147454f..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Controls.Grid.html +++ /dev/null @@ -1,185 +0,0 @@ -Grid | xrm-ex
-
- -
-
-
- -
-
-

Index

-
-

Interfaces

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Controls.html b/docs/modules/node_modules__types_xrm.Xrm.Controls.html deleted file mode 100644 index bb56b43..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Controls.html +++ /dev/null @@ -1,235 +0,0 @@ -Controls | xrm-ex
-
- -
-
- -
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Device.html b/docs/modules/node_modules__types_xrm.Xrm.Device.html deleted file mode 100644 index b78cba8..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Device.html +++ /dev/null @@ -1,145 +0,0 @@ -Device | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Events.Attribute.html b/docs/modules/node_modules__types_xrm.Xrm.Events.Attribute.html deleted file mode 100644 index 5be8c05..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Events.Attribute.html +++ /dev/null @@ -1,169 +0,0 @@ -Attribute | xrm-ex
-
- -
-
-
-
- -

Namespace Attribute

-
-
-

Index

-
-

Interfaces

-
-
-

Type Aliases

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Events.GridControl.html b/docs/modules/node_modules__types_xrm.Xrm.Events.GridControl.html deleted file mode 100644 index 059d993..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Events.GridControl.html +++ /dev/null @@ -1,169 +0,0 @@ -GridControl | xrm-ex
-
- -
-
-
-
- -

Namespace GridControl

-
-
-

Index

-
-

Interfaces

-
-
-

Type Aliases

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Events.KbSearchControl.html b/docs/modules/node_modules__types_xrm.Xrm.Events.KbSearchControl.html deleted file mode 100644 index fd5d1ab..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Events.KbSearchControl.html +++ /dev/null @@ -1,177 +0,0 @@ -KbSearchControl | xrm-ex
-
- -
-
-
-
- -

Namespace KbSearchControl

-
-
-

Index

-
-

Interfaces

-
-
-

Type Aliases

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Events.html b/docs/modules/node_modules__types_xrm.Xrm.Events.html deleted file mode 100644 index 0cf5de9..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Events.html +++ /dev/null @@ -1,197 +0,0 @@ -Events | xrm-ex
-
- -
-
- -
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Metadata.html b/docs/modules/node_modules__types_xrm.Xrm.Metadata.html deleted file mode 100644 index b5b6530..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Metadata.html +++ /dev/null @@ -1,139 +0,0 @@ -Metadata | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Navigation.NavigationOptions.html b/docs/modules/node_modules__types_xrm.Xrm.Navigation.NavigationOptions.html deleted file mode 100644 index 64d12f4..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Navigation.NavigationOptions.html +++ /dev/null @@ -1,149 +0,0 @@ -NavigationOptions | xrm-ex
-
- -
-
-
-
- -

Namespace NavigationOptions

-
-
-

Index

-
-

Interfaces

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Navigation.html b/docs/modules/node_modules__types_xrm.Xrm.Navigation.html deleted file mode 100644 index cd901d1..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Navigation.html +++ /dev/null @@ -1,169 +0,0 @@ -Navigation | xrm-ex
-
- -
-
-
-
- -

Namespace Navigation

-
-

Namespace to hold Xrm.Navigation related types

-
-
-
-
-

Index

-
-

Namespaces

-
-
-

Interfaces

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Page.data.html b/docs/modules/node_modules__types_xrm.Xrm.Page.data.html deleted file mode 100644 index 26d7035..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Page.data.html +++ /dev/null @@ -1,221 +0,0 @@ -data | xrm-ex
-
- -
-
-
-
- -

Namespace data

-
-

Module for the Xrm.Page.data API.

-
-
-

Deprecated

Use Xrm.Form.data formContext.data has been deprecated.

-
-
-
-

Index

-
-

Interfaces

-
-
-

Type Aliases

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Page.html b/docs/modules/node_modules__types_xrm.Xrm.Page.html deleted file mode 100644 index 5489f17..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Page.html +++ /dev/null @@ -1,282 +0,0 @@ -Page | xrm-ex
-
- -
-
-
-
- -

Namespace Page

-
-

Xrm.Page namespace has been deprecated

-
-
-

Deprecated

Use formContext instead.

- -

See

External Link: Deprecated Client APIs

-
-
-
-

Index

-
-

Namespaces

-
data -ui -
-
-

Interfaces

-
-
-

Type Aliases

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Page.ui.html b/docs/modules/node_modules__types_xrm.Xrm.Page.ui.html deleted file mode 100644 index 50b6596..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Page.ui.html +++ /dev/null @@ -1,229 +0,0 @@ -ui | xrm-ex
-
- -
-
-
-
- -

Namespace ui

-
-

Contains properties and methods to retrieve information about the user interface as well as collections for several subcomponents of the form.

-
-
-

Deprecated

Use Xrm.Form.ui formContext.ui instead.

-
-
-
-

Index

-
-

Interfaces

-
-
-

Type Aliases

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.ProcessFlow.html b/docs/modules/node_modules__types_xrm.Xrm.ProcessFlow.html deleted file mode 100644 index 32eca34..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.ProcessFlow.html +++ /dev/null @@ -1,152 +0,0 @@ -ProcessFlow | xrm-ex
-
- -
-
-
-
- -

Namespace ProcessFlow

-
-
-

Index

-
-

Interfaces

-
-
-

Type Aliases

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Url.html b/docs/modules/node_modules__types_xrm.Xrm.Url.html deleted file mode 100644 index f534556..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Url.html +++ /dev/null @@ -1,148 +0,0 @@ -Url | xrm-ex
-
- -
-
-
-
- -

Namespace Url

-
-

An definition module for URL-based, CRM component parameters.

-
-
-
-
-

Index

-
-

Interfaces

-
-
-

Type Aliases

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.Utility.html b/docs/modules/node_modules__types_xrm.Xrm.Utility.html deleted file mode 100644 index cd7f052..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.Utility.html +++ /dev/null @@ -1,138 +0,0 @@ -Utility | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.Xrm.html b/docs/modules/node_modules__types_xrm.Xrm.html deleted file mode 100644 index 97aa54b..0000000 --- a/docs/modules/node_modules__types_xrm.Xrm.html +++ /dev/null @@ -1,194 +0,0 @@ -Xrm | xrm-ex
-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.XrmEnum.html b/docs/modules/node_modules__types_xrm.XrmEnum.html deleted file mode 100644 index 8a35a3c..0000000 --- a/docs/modules/node_modules__types_xrm.XrmEnum.html +++ /dev/null @@ -1,137 +0,0 @@ -XrmEnum | xrm-ex
-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/node_modules__types_xrm.html b/docs/modules/node_modules__types_xrm.html deleted file mode 100644 index af3fa7a..0000000 --- a/docs/modules/node_modules__types_xrm.html +++ /dev/null @@ -1,70 +0,0 @@ -node_modules/@types/xrm | xrm-ex
-
- -
-
-
-
- -

Module node_modules/@types/xrm

-
-
-

Index

-
-

Namespaces

-
-
-

Interfaces

-
-
-

Variables

-
-
-

Functions

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/src_XrmEx.XrmEx.Class.html b/docs/modules/src_XrmEx.XrmEx.Class.html deleted file mode 100644 index 5947dac..0000000 --- a/docs/modules/src_XrmEx.XrmEx.Class.html +++ /dev/null @@ -1,97 +0,0 @@ -Class | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/src_XrmEx.XrmEx.html b/docs/modules/src_XrmEx.XrmEx.html deleted file mode 100644 index e9ca7d5..0000000 --- a/docs/modules/src_XrmEx.XrmEx.html +++ /dev/null @@ -1,92 +0,0 @@ -XrmEx | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules/src_XrmEx.html b/docs/modules/src_XrmEx.html deleted file mode 100644 index c8cde27..0000000 --- a/docs/modules/src_XrmEx.html +++ /dev/null @@ -1,53 +0,0 @@ -src/XrmEx | xrm-ex
-
- -
-
-
-
- -

Module src/XrmEx

-
-
-

Index

-
-

Namespaces

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Attributes.AttributeFormat.html b/docs/types/node_modules__types_xrm.Xrm.Attributes.AttributeFormat.html deleted file mode 100644 index 67fa584..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Attributes.AttributeFormat.html +++ /dev/null @@ -1,147 +0,0 @@ -AttributeFormat | xrm-ex
-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Attributes.AttributeType.html b/docs/types/node_modules__types_xrm.Xrm.Attributes.AttributeType.html deleted file mode 100644 index 688bebf..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Attributes.AttributeType.html +++ /dev/null @@ -1,142 +0,0 @@ -AttributeType | xrm-ex
-
- -
-
-
-
- -

Type alias AttributeType

-
AttributeType: "boolean" | "datetime" | "decimal" | "double" | "integer" | "lookup" | "memo" | "money" | "multiselectoptionset" | "optionset" | "string"
-

Attribute types for Attributes.Attribute.setDisplayState().

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Attributes.DateAttributeFormat.html b/docs/types/node_modules__types_xrm.Xrm.Attributes.DateAttributeFormat.html deleted file mode 100644 index 9087261..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Attributes.DateAttributeFormat.html +++ /dev/null @@ -1,142 +0,0 @@ -DateAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Type alias DateAttributeFormat

-
DateAttributeFormat: "date" | "datetime"
-

Date attribute formats for Attributes.Attribute.getFormat(), used by DateAttribute.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Attributes.IntegerAttributeFormat.html b/docs/types/node_modules__types_xrm.Xrm.Attributes.IntegerAttributeFormat.html deleted file mode 100644 index b281798..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Attributes.IntegerAttributeFormat.html +++ /dev/null @@ -1,142 +0,0 @@ -IntegerAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Type alias IntegerAttributeFormat

-
IntegerAttributeFormat: "duration" | "none"
-

Integer attribute formats for Attributes.Attribute.getFormat(), used by NumberAttribute.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Attributes.OptionSetAttributeFormat.html b/docs/types/node_modules__types_xrm.Xrm.Attributes.OptionSetAttributeFormat.html deleted file mode 100644 index 69330df..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Attributes.OptionSetAttributeFormat.html +++ /dev/null @@ -1,142 +0,0 @@ -OptionSetAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Type alias OptionSetAttributeFormat

-
OptionSetAttributeFormat: "language" | "timezone"
-

OptionSet attribute formats for Attributes.Attribute.getFormat(), used by OptionSetAttribute.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Attributes.RequirementLevel.html b/docs/types/node_modules__types_xrm.Xrm.Attributes.RequirementLevel.html deleted file mode 100644 index 85654a1..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Attributes.RequirementLevel.html +++ /dev/null @@ -1,143 +0,0 @@ -RequirementLevel | xrm-ex
-
- -
-
-
-
- -

Type alias RequirementLevel

-
RequirementLevel: "none" | "recommended" | "required"
- -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Attributes.StringAttributeFormat.html b/docs/types/node_modules__types_xrm.Xrm.Attributes.StringAttributeFormat.html deleted file mode 100644 index 1d6db4a..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Attributes.StringAttributeFormat.html +++ /dev/null @@ -1,142 +0,0 @@ -StringAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Type alias StringAttributeFormat

-
StringAttributeFormat: "email" | "phone" | "text" | "textarea" | "tickersymbol" | "url"
-

String attribute formats for Attributes.Attribute.getFormat(), used by StringAttribute.

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Client.html b/docs/types/node_modules__types_xrm.Xrm.Client.html deleted file mode 100644 index e82ae59..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Client.html +++ /dev/null @@ -1,122 +0,0 @@ -Client | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.ClientState.html b/docs/types/node_modules__types_xrm.Xrm.ClientState.html deleted file mode 100644 index 02ca453..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.ClientState.html +++ /dev/null @@ -1,122 +0,0 @@ -ClientState | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Collection.IterativeDelegate.html b/docs/types/node_modules__types_xrm.Xrm.Collection.IterativeDelegate.html deleted file mode 100644 index 04e6a1a..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Collection.IterativeDelegate.html +++ /dev/null @@ -1,155 +0,0 @@ -IterativeDelegate | xrm-ex
-
- -
-
-
-
- -

Type alias IterativeDelegate<T>

-
IterativeDelegate<T>: ((item, index?) => void)
-
-

Type Parameters

-
    -
  • -

    T

-
-

Type declaration

-
    -
  • -
      -
    • (item, index?): void
    • -
    • -

      Called for each item in an array

      -
      -
      -

      Parameters

      -
        -
      • -
        item: T
        -

        The item.

        -
        -
      • -
      • -
        Optional index: number
        -

        Zero-based index of the item array.

        -
        -
      -

      Returns void

      -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Collection.MatchingDelegate.html b/docs/types/node_modules__types_xrm.Xrm.Collection.MatchingDelegate.html deleted file mode 100644 index 2c007ad..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Collection.MatchingDelegate.html +++ /dev/null @@ -1,156 +0,0 @@ -MatchingDelegate | xrm-ex
-
- -
-
-
-
- -

Type alias MatchingDelegate<T>

-
MatchingDelegate<T>: ((item, index?) => boolean)
-
-

Type Parameters

-
    -
  • -

    T

-
-

Type declaration

-
    -
  • -
      -
    • (item, index?): boolean
    • -
    • -

      Called for each item in an array

      -
      -
      -

      Parameters

      -
        -
      • -
        item: T
        -

        The item.

        -
        -
      • -
      • -
        Optional index: number
        -

        Zero-based index of the item array.

        -
        -
      -

      Returns boolean

      true if the item matches, false if it does not.

      - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Collection.StringIndexableItemCollection.html b/docs/types/node_modules__types_xrm.Xrm.Collection.StringIndexableItemCollection.html deleted file mode 100644 index 7d936f0..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Collection.StringIndexableItemCollection.html +++ /dev/null @@ -1,136 +0,0 @@ -StringIndexableItemCollection | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Controls.ControlQuickFormType.html b/docs/types/node_modules__types_xrm.Xrm.Controls.ControlQuickFormType.html deleted file mode 100644 index a44f103..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Controls.ControlQuickFormType.html +++ /dev/null @@ -1,173 +0,0 @@ -ControlQuickFormType | xrm-ex
-
- -
-
-
-
- -

Type alias ControlQuickFormType

-
ControlQuickFormType: "quickform"
-

Control type for formContext.ui.quickForms.getControlType().

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Controls.ControlType.html b/docs/types/node_modules__types_xrm.Xrm.Controls.ControlType.html deleted file mode 100644 index 479cf09..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Controls.ControlType.html +++ /dev/null @@ -1,175 +0,0 @@ -ControlType | xrm-ex
-
- -
-
-
-
- -

Type alias ControlType

-
ControlType: "standard" | "iframe" | "lookup" | "optionset" | "subgrid" | "webresource" | "notes" | "timercontrol" | "kbsearch" | "timelinewall" | Xrm.Controls.ControlQuickFormType
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Controls.NotificationLevel.html b/docs/types/node_modules__types_xrm.Xrm.Controls.NotificationLevel.html deleted file mode 100644 index 89ea844..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Controls.NotificationLevel.html +++ /dev/null @@ -1,173 +0,0 @@ -NotificationLevel | xrm-ex
-
- -
-
-
-
- -

Type alias NotificationLevel

-
NotificationLevel: "ERROR" | "RECOMMENDATION"
-

Constants to use with the addNotification method of form controls

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Device.PickFileTypes.html b/docs/types/node_modules__types_xrm.Xrm.Device.PickFileTypes.html deleted file mode 100644 index 5d006bf..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Device.PickFileTypes.html +++ /dev/null @@ -1,131 +0,0 @@ -PickFileTypes | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.DisplayState.html b/docs/types/node_modules__types_xrm.Xrm.DisplayState.html deleted file mode 100644 index ba053e2..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.DisplayState.html +++ /dev/null @@ -1,122 +0,0 @@ -DisplayState | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.EntitySaveMode.html b/docs/types/node_modules__types_xrm.Xrm.EntitySaveMode.html deleted file mode 100644 index 060fd8d..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.EntitySaveMode.html +++ /dev/null @@ -1,126 +0,0 @@ -EntitySaveMode | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.Attribute.ChangeEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.Attribute.ChangeEventHandler.html deleted file mode 100644 index 2a992bf..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.Attribute.ChangeEventHandler.html +++ /dev/null @@ -1,173 +0,0 @@ -ChangeEventHandler | xrm-ex
-
- -
-
-
-
- -

Type alias ChangeEventHandler

-
ChangeEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.ContextSensitiveHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.ContextSensitiveHandler.html deleted file mode 100644 index 8b8fd7c..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.ContextSensitiveHandler.html +++ /dev/null @@ -1,173 +0,0 @@ -ContextSensitiveHandler | xrm-ex
-
- -
-
-
-
- -

Type alias ContextSensitiveHandler

-
ContextSensitiveHandler: ((context) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (context): void
    • -
    • -

      Type for a context-sensitive handler.

      -
      -
      -

      Parameters

      -
      -

      Returns void

      -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.DataLoadEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.DataLoadEventHandler.html deleted file mode 100644 index a31986f..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.DataLoadEventHandler.html +++ /dev/null @@ -1,167 +0,0 @@ -DataLoadEventHandler | xrm-ex
-
- -
-
-
-
- -

Type alias DataLoadEventHandler

-
DataLoadEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.GridControl.LoadEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.GridControl.LoadEventHandler.html deleted file mode 100644 index dc21426..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.GridControl.LoadEventHandler.html +++ /dev/null @@ -1,173 +0,0 @@ -LoadEventHandler | xrm-ex
-
- -
-
-
- -
LoadEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.PostSearchEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.PostSearchEventHandler.html deleted file mode 100644 index 81e3bed..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.PostSearchEventHandler.html +++ /dev/null @@ -1,177 +0,0 @@ -PostSearchEventHandler | xrm-ex
-
- -
-
-
- -
PostSearchEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.ResultOpenedEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.ResultOpenedEventHandler.html deleted file mode 100644 index b40d5ef..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.ResultOpenedEventHandler.html +++ /dev/null @@ -1,177 +0,0 @@ -ResultOpenedEventHandler | xrm-ex
-
- -
-
-
- -
ResultOpenedEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.SelectionEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.SelectionEventHandler.html deleted file mode 100644 index e1fc2cf..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.KbSearchControl.SelectionEventHandler.html +++ /dev/null @@ -1,177 +0,0 @@ -SelectionEventHandler | xrm-ex
-
- -
-
-
- -
SelectionEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.LoadEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.LoadEventHandler.html deleted file mode 100644 index 2079fe6..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.LoadEventHandler.html +++ /dev/null @@ -1,167 +0,0 @@ -LoadEventHandler | xrm-ex
-
- -
-
-
-
- -

Type alias LoadEventHandler

-
LoadEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.LoadEventHandlerAsync.html b/docs/types/node_modules__types_xrm.Xrm.Events.LoadEventHandlerAsync.html deleted file mode 100644 index 26001a2..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.LoadEventHandlerAsync.html +++ /dev/null @@ -1,167 +0,0 @@ -LoadEventHandlerAsync | xrm-ex
-
- -
-
-
-
- -

Type alias LoadEventHandlerAsync

-
LoadEventHandlerAsync: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.LookupTagClickHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.LookupTagClickHandler.html deleted file mode 100644 index 303a961..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.LookupTagClickHandler.html +++ /dev/null @@ -1,167 +0,0 @@ -LookupTagClickHandler | xrm-ex
-
- -
-
-
-
- -

Type alias LookupTagClickHandler

-
LookupTagClickHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.PostSaveEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.PostSaveEventHandler.html deleted file mode 100644 index 10cf72c..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.PostSaveEventHandler.html +++ /dev/null @@ -1,167 +0,0 @@ -PostSaveEventHandler | xrm-ex
-
- -
-
-
-
- -

Type alias PostSaveEventHandler

-
PostSaveEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.ProcessStatusChangeHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.ProcessStatusChangeHandler.html deleted file mode 100644 index 7bef9b5..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.ProcessStatusChangeHandler.html +++ /dev/null @@ -1,167 +0,0 @@ -ProcessStatusChangeHandler | xrm-ex
-
- -
-
-
-
- -

Type alias ProcessStatusChangeHandler

-
ProcessStatusChangeHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.SaveEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.SaveEventHandler.html deleted file mode 100644 index 133416d..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.SaveEventHandler.html +++ /dev/null @@ -1,167 +0,0 @@ -SaveEventHandler | xrm-ex
-
- -
-
-
-
- -

Type alias SaveEventHandler

-
SaveEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.SaveEventHandlerAsync.html b/docs/types/node_modules__types_xrm.Xrm.Events.SaveEventHandlerAsync.html deleted file mode 100644 index 2a8ba1c..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.SaveEventHandlerAsync.html +++ /dev/null @@ -1,167 +0,0 @@ -SaveEventHandlerAsync | xrm-ex
-
- -
-
-
-
- -

Type alias SaveEventHandlerAsync

-
SaveEventHandlerAsync: ((context) => PromiseLike<void>)
-
-

Type declaration

-
    -
  • -
      -
    • (context): PromiseLike<void>
    • -
    • -
      -

      Parameters

      -
      -

      Returns PromiseLike<void>

-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.StageChangeEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.StageChangeEventHandler.html deleted file mode 100644 index ef0d661..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.StageChangeEventHandler.html +++ /dev/null @@ -1,167 +0,0 @@ -StageChangeEventHandler | xrm-ex
-
- -
-
-
-
- -

Type alias StageChangeEventHandler

-
StageChangeEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Events.StageSelectedEventHandler.html b/docs/types/node_modules__types_xrm.Xrm.Events.StageSelectedEventHandler.html deleted file mode 100644 index 7b313c0..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Events.StageSelectedEventHandler.html +++ /dev/null @@ -1,167 +0,0 @@ -StageSelectedEventHandler | xrm-ex
-
- -
-
-
-
- -

Type alias StageSelectedEventHandler

-
StageSelectedEventHandler: ((context) => void)
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.FormNotificationLevel.html b/docs/types/node_modules__types_xrm.Xrm.FormNotificationLevel.html deleted file mode 100644 index 4740c2b..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.FormNotificationLevel.html +++ /dev/null @@ -1,122 +0,0 @@ -FormNotificationLevel | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.AttributeFormat.html b/docs/types/node_modules__types_xrm.Xrm.Page.AttributeFormat.html deleted file mode 100644 index 34b2a43..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.AttributeFormat.html +++ /dev/null @@ -1,197 +0,0 @@ -AttributeFormat | xrm-ex
-
- -
-
-
-
- -

Type alias AttributeFormat

-
AttributeFormat: Xrm.Attributes.AttributeFormat
-

Attribute formats for Xrm.Page.Attribute.getFormat().

-
-
-

Deprecated

Use AttributeFormat instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.AttributeType.html b/docs/types/node_modules__types_xrm.Xrm.Page.AttributeType.html deleted file mode 100644 index d75265b..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.AttributeType.html +++ /dev/null @@ -1,197 +0,0 @@ -AttributeType | xrm-ex
-
- -
-
-
-
- -

Type alias AttributeType

- -

Attribute types for Xrm.ui.ProcessMonitor Xrm.Page.Attribute.setDisplayState().

-
-
-

Deprecated

Use AttributeType instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.ContextSensitiveHandler.html b/docs/types/node_modules__types_xrm.Xrm.Page.ContextSensitiveHandler.html deleted file mode 100644 index b00f511..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.ContextSensitiveHandler.html +++ /dev/null @@ -1,199 +0,0 @@ -ContextSensitiveHandler | xrm-ex
-
- -
-
-
-
- -

Type alias ContextSensitiveHandler

-
ContextSensitiveHandler: Xrm.Events.ContextSensitiveHandler
-

Type for a context-sensitive handler.

-
-
-

Param

The context.

- -

Deprecated

Use ContextSensitiveHandler instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.ControlQuickFormType.html b/docs/types/node_modules__types_xrm.Xrm.Page.ControlQuickFormType.html deleted file mode 100644 index 7d6afc7..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.ControlQuickFormType.html +++ /dev/null @@ -1,197 +0,0 @@ -ControlQuickFormType | xrm-ex
-
- -
-
-
-
- -

Type alias ControlQuickFormType

-
ControlQuickFormType: Xrm.Controls.ControlQuickFormType
-

Control type for Xrm.Page.ui.QuickForm.getControlType().

-
-
-

Deprecated

Use ControlQuickFormType instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.ControlType.html b/docs/types/node_modules__types_xrm.Xrm.Page.ControlType.html deleted file mode 100644 index 7ce2f65..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.ControlType.html +++ /dev/null @@ -1,197 +0,0 @@ -ControlType | xrm-ex
-
- -
-
-
-
- -

Type alias ControlType

-
ControlType: Xrm.Controls.ControlType
-

Control types for Xrm.Page.Control.getControlType().

-
-
-

Deprecated

Use ControlType instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.DateAttributeFormat.html b/docs/types/node_modules__types_xrm.Xrm.Page.DateAttributeFormat.html deleted file mode 100644 index cab76c9..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.DateAttributeFormat.html +++ /dev/null @@ -1,197 +0,0 @@ -DateAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Type alias DateAttributeFormat

-
DateAttributeFormat: Xrm.Attributes.DateAttributeFormat
-

Date attribute formats for Xrm.Page.Attribute.getFormat(), used by DateAttribute.

-
-
-

Deprecated

Use DateAttributeFormat instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.IntegerAttributeFormat.html b/docs/types/node_modules__types_xrm.Xrm.Page.IntegerAttributeFormat.html deleted file mode 100644 index 73f97ca..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.IntegerAttributeFormat.html +++ /dev/null @@ -1,197 +0,0 @@ -IntegerAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Type alias IntegerAttributeFormat

-
IntegerAttributeFormat: Xrm.Attributes.IntegerAttributeFormat
-

Integer attribute formats for Xrm.Page.Attribute.getFormat(), used by NumberAttribute.

-
-
-

Deprecated

Use IntegerAttributeFormat instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.NotificationLevel.html b/docs/types/node_modules__types_xrm.Xrm.Page.NotificationLevel.html deleted file mode 100644 index bc9acf9..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.NotificationLevel.html +++ /dev/null @@ -1,197 +0,0 @@ -NotificationLevel | xrm-ex
-
- -
-
-
-
- -

Type alias NotificationLevel

-
NotificationLevel: Xrm.Controls.NotificationLevel
-

Constants to use with the addNotification method of form controls

-
-
-

Deprecated

Use NotificationLevel instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.OptionSetAttributeFormat.html b/docs/types/node_modules__types_xrm.Xrm.Page.OptionSetAttributeFormat.html deleted file mode 100644 index e32cf24..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.OptionSetAttributeFormat.html +++ /dev/null @@ -1,197 +0,0 @@ -OptionSetAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Type alias OptionSetAttributeFormat

-
OptionSetAttributeFormat: Xrm.Attributes.OptionSetAttributeFormat
-

OptionSet attribute formats for Xrm.Page.Attribute.getFormat(), used by OptionSetAttribute.

-
-
-

Deprecated

Use Xrm.Attributes.OptiopnSetAttributeFormat instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.ProcessStatus.html b/docs/types/node_modules__types_xrm.Xrm.Page.ProcessStatus.html deleted file mode 100644 index 0882184..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.ProcessStatus.html +++ /dev/null @@ -1,197 +0,0 @@ -ProcessStatus | xrm-ex
-
- -
-
-
-
- -

Type alias ProcessStatus

- -

Status for Xrm.Page.Process.getStatus().

-
-
-

Deprecated

Use ProcessStatus instead

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.ProcessStatusChangeHandler.html b/docs/types/node_modules__types_xrm.Xrm.Page.ProcessStatusChangeHandler.html deleted file mode 100644 index 1e66f4f..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.ProcessStatusChangeHandler.html +++ /dev/null @@ -1,199 +0,0 @@ -ProcessStatusChangeHandler | xrm-ex
-
- -
-
-
-
- -

Type alias ProcessStatusChangeHandler

-
ProcessStatusChangeHandler: Xrm.Events.ProcessStatusChangeHandler
-

Type for a process status change handler.

-
-
-

Param

The process status.

- -

Deprecated

Use ProcessStatusChangeHandler instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.RequirementLevel.html b/docs/types/node_modules__types_xrm.Xrm.Page.RequirementLevel.html deleted file mode 100644 index 71ec079..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.RequirementLevel.html +++ /dev/null @@ -1,197 +0,0 @@ -RequirementLevel | xrm-ex
-
- -
-
-
-
- -

Type alias RequirementLevel

-
RequirementLevel: Xrm.Attributes.RequirementLevel
-

Requirement Level for Xrm.Page.Attribute.getRequiredLevel() and Xrm.Page.Attribute.setRequiredLevel().

-
-
-

Deprecated

Use RequirementLevel instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.SaveMode.html b/docs/types/node_modules__types_xrm.Xrm.Page.SaveMode.html deleted file mode 100644 index 402f007..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.SaveMode.html +++ /dev/null @@ -1,197 +0,0 @@ -SaveMode | xrm-ex
-
- -
-
-
-
- -

Type alias SaveMode

- -

Save Modes for Xrm.Page.Entity.save().

-
-
-

Deprecated

Use EntitySaveMode instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.StageChangeDirection.html b/docs/types/node_modules__types_xrm.Xrm.Page.StageChangeDirection.html deleted file mode 100644 index 8e07cc7..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.StageChangeDirection.html +++ /dev/null @@ -1,197 +0,0 @@ -StageChangeDirection | xrm-ex
-
- -
-
-
-
- -

Type alias StageChangeDirection

-
StageChangeDirection: Xrm.ProcessFlow.StageChangeDirection
-

Direction types for a process stage change event

-
-
-

Deprecated

Use StageChangeDirection instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.StageStatus.html b/docs/types/node_modules__types_xrm.Xrm.Page.StageStatus.html deleted file mode 100644 index 384d3b0..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.StageStatus.html +++ /dev/null @@ -1,197 +0,0 @@ -StageStatus | xrm-ex
-
- -
-
-
-
- -

Type alias StageStatus

- -

Status for Xrm.Page.Stage.getStatus().

-
-
-

Deprecated

Use StageStatus instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.StringAttributeFormat.html b/docs/types/node_modules__types_xrm.Xrm.Page.StringAttributeFormat.html deleted file mode 100644 index 51bb77d..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.StringAttributeFormat.html +++ /dev/null @@ -1,197 +0,0 @@ -StringAttributeFormat | xrm-ex
-
- -
-
-
-
- -

Type alias StringAttributeFormat

-
StringAttributeFormat: Xrm.Attributes.StringAttributeFormat
-

String attribute formats for Xrm.Page.Attribute.getFormat(), used by StringAttribute.

-
-
-

Deprecated

Use StringAttributeFormat instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.SubmitMode.html b/docs/types/node_modules__types_xrm.Xrm.Page.SubmitMode.html deleted file mode 100644 index 57e2c9e..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.SubmitMode.html +++ /dev/null @@ -1,197 +0,0 @@ -SubmitMode | xrm-ex
-
- -
-
-
-
- -

Type alias SubmitMode

-
SubmitMode: Xrm.SubmitMode
-

Submit Mode for Xrm.Page.Attribute.getSubmitMode() and Xrm.Page.Attribute.setSubmitMode().

-
-
-

Deprecated

Use SubmitMode instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.data.GetProcessInstancesDelegate.html b/docs/types/node_modules__types_xrm.Xrm.Page.data.GetProcessInstancesDelegate.html deleted file mode 100644 index d6e0205..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.data.GetProcessInstancesDelegate.html +++ /dev/null @@ -1,219 +0,0 @@ -GetProcessInstancesDelegate | xrm-ex
-
- -
-
-
-
- -

Type alias GetProcessInstancesDelegate

-
GetProcessInstancesDelegate: Xrm.ProcessFlow.GetProcessInstancesDelegate
-

Called when method to get active processes is complete

-
-
-

Param

The result of the get active processes operation.

- -

Remarks

Returns object with the following key-value pairs:

-
    -
  • CreatedOn
  • -
  • ProcessDefinitionID
  • -
  • ProcessDefinitionName
  • -
  • ProcessInstanceID
  • -
  • ProcessInstanceName
  • -
  • StatusCodeName
  • -
- -

Deprecated

Use GetProcessInstancesDelegate instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.data.ProcessCallbackDelegate.html b/docs/types/node_modules__types_xrm.Xrm.Page.data.ProcessCallbackDelegate.html deleted file mode 100644 index 37089ef..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.data.ProcessCallbackDelegate.html +++ /dev/null @@ -1,218 +0,0 @@ -ProcessCallbackDelegate | xrm-ex
-
- -
-
-
-
- -

Type alias ProcessCallbackDelegate

-
ProcessCallbackDelegate: Xrm.ProcessFlow.ProcessCallbackDelegate
-

Called when process change methods have completed.

-
-
-

Param

The result of the process change operation.

- -

Remarks

Values returned are:

-
    -
  • success (The operation succeeded.)
  • -
  • crossEntity (The previous stage is for a different entity.)
  • -
  • beginning (The active stage is the first stage of the active path.)
  • -
  • invalid (The operation failed because the selected stage isn’t the same as the active stage.)
  • -
  • unreachable (The stage exists on a different path.)
  • -
- -

Deprecated

Use ProcessCallbackDelegate instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.data.ProcessSetStatusDelegate.html b/docs/types/node_modules__types_xrm.Xrm.Page.data.ProcessSetStatusDelegate.html deleted file mode 100644 index b684cc3..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.data.ProcessSetStatusDelegate.html +++ /dev/null @@ -1,216 +0,0 @@ -ProcessSetStatusDelegate | xrm-ex
-
- -
-
-
-
- -

Type alias ProcessSetStatusDelegate

-
ProcessSetStatusDelegate: Xrm.ProcessFlow.ProcessSetStatusDelegate
-

Called when process set status method has completed.

-
-
-

Param

The new status of the process instance

- -

Remarks

Values returned are:

-
    -
  • active
  • -
  • aborted
  • -
  • finished
  • -
- -

Deprecated

Use ProcessSetStatusDelegate instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.data.SetProcessInstanceDelegate.html b/docs/types/node_modules__types_xrm.Xrm.Page.data.SetProcessInstanceDelegate.html deleted file mode 100644 index da316ac..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.data.SetProcessInstanceDelegate.html +++ /dev/null @@ -1,215 +0,0 @@ -SetProcessInstanceDelegate | xrm-ex
-
- -
-
-
-
- -

Type alias SetProcessInstanceDelegate

-
SetProcessInstanceDelegate: Xrm.ProcessFlow.SetProcessInstanceDelegate
-

Called when method to set active process is complete

-
-
-

Param

The result of the set active process operation.

- -

Remarks

Values returned are:

-
    -
  • success (The operation succeeded.)
  • -
  • invalid (The processInstanceId isn’t valid or the process isn’t enabled.)
  • -
- -

Deprecated

Use SetProcessInstanceDelegate instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.ui.DisplayState.html b/docs/types/node_modules__types_xrm.Xrm.Page.ui.DisplayState.html deleted file mode 100644 index 5a3efc4..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.ui.DisplayState.html +++ /dev/null @@ -1,211 +0,0 @@ -DisplayState | xrm-ex
-
- -
-
-
-
- -

Type alias DisplayState

-
DisplayState: Xrm.DisplayState
-

Display States for Xrm.ui.ProcessMonitor.setDisplayState().

-
-
-

Deprecated

Use DisplayState instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Page.ui.FormNotificationLevel.html b/docs/types/node_modules__types_xrm.Xrm.Page.ui.FormNotificationLevel.html deleted file mode 100644 index e2bbf61..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Page.ui.FormNotificationLevel.html +++ /dev/null @@ -1,211 +0,0 @@ -FormNotificationLevel | xrm-ex
-
- -
-
-
-
- -

Type alias FormNotificationLevel

-
FormNotificationLevel: Xrm.FormNotificationLevel
-

Form Notification Levels for Xrm.Ui.setFormNotification().

-
-
-

Deprecated

Use FormNotificationLevel instead.

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.GetProcessInstancesDelegate.html b/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.GetProcessInstancesDelegate.html deleted file mode 100644 index abf4cb7..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.GetProcessInstancesDelegate.html +++ /dev/null @@ -1,159 +0,0 @@ -GetProcessInstancesDelegate | xrm-ex
-
- -
-
-
-
- -

Type alias GetProcessInstancesDelegate

-
GetProcessInstancesDelegate: ((object) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (object): void
    • -
    • -

      Called when method to get active processes is complete

      -
      -
      -

      Parameters

      -
      -

      Returns void

      -
      -

      Remarks

      Returns object with the following key-value pairs:

      -
        -
      • CreatedOn
      • -
      • ProcessDefinitionID
      • -
      • ProcessDefinitionName
      • -
      • ProcessInstanceID
      • -
      • ProcessInstanceName
      • -
      • StatusCodeName
      • -
      -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessCallbackDelegate.html b/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessCallbackDelegate.html deleted file mode 100644 index 8a6f62a..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessCallbackDelegate.html +++ /dev/null @@ -1,161 +0,0 @@ -ProcessCallbackDelegate | xrm-ex
-
- -
-
-
-
- -

Type alias ProcessCallbackDelegate

-
ProcessCallbackDelegate: ((status) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (status): void
    • -
    • -

      Called when process change methods have completed.

      -
      -
      -

      Parameters

      -
        -
      • -
        status: string
        -

        The result of the process change operation.

        -
        -
      -

      Returns void

      -
      -

      Remarks

      Values returned are:

      -
        -
      • success (The operation succeeded.)
      • -
      • crossEntity (The previous stage is for a different entity.)
      • -
      • beginning (The active stage is the first stage of the active path.)
      • -
      • invalid (The operation failed because the selected stage isn’t the same as the active stage.)
      • -
      • unreachable (The stage exists on a different path.)
      • -
      -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessSetStatusDelegate.html b/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessSetStatusDelegate.html deleted file mode 100644 index 646fe67..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessSetStatusDelegate.html +++ /dev/null @@ -1,152 +0,0 @@ -ProcessSetStatusDelegate | xrm-ex
-
- -
-
-
-
- -

Type alias ProcessSetStatusDelegate

-
ProcessSetStatusDelegate: ((status) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (status): void
    • -
    • -

      Called when process set status method has completed.

      -
      -
      -

      Parameters

      -
      -

      Returns void

      -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessStatus.html b/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessStatus.html deleted file mode 100644 index b68aefe..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.ProcessStatus.html +++ /dev/null @@ -1,138 +0,0 @@ -ProcessStatus | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.SetProcessInstanceDelegate.html b/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.SetProcessInstanceDelegate.html deleted file mode 100644 index 3cfe351..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.SetProcessInstanceDelegate.html +++ /dev/null @@ -1,158 +0,0 @@ -SetProcessInstanceDelegate | xrm-ex
-
- -
-
-
-
- -

Type alias SetProcessInstanceDelegate

-
SetProcessInstanceDelegate: ((status) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (status): void
    • -
    • -

      Called when method to set active process is complete

      -
      -
      -

      Parameters

      -
        -
      • -
        status: string
        -

        The result of the set active process operation.

        -
        -
      -

      Returns void

      -
      -

      Remarks

      Values returned are:

      -
        -
      • success (The operation succeeded.)
      • -
      • invalid (The processInstanceId isn’t valid or the process isn’t enabled.)
      • -
      -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.StageChangeDirection.html b/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.StageChangeDirection.html deleted file mode 100644 index 1757cef..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.StageChangeDirection.html +++ /dev/null @@ -1,138 +0,0 @@ -StageChangeDirection | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.StageStatus.html b/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.StageStatus.html deleted file mode 100644 index fa67c3a..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.ProcessFlow.StageStatus.html +++ /dev/null @@ -1,138 +0,0 @@ -StageStatus | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.SubmitMode.html b/docs/types/node_modules__types_xrm.Xrm.SubmitMode.html deleted file mode 100644 index 4248ab9..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.SubmitMode.html +++ /dev/null @@ -1,122 +0,0 @@ -SubmitMode | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Theme.html b/docs/types/node_modules__types_xrm.Xrm.Theme.html deleted file mode 100644 index ecc46b9..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Theme.html +++ /dev/null @@ -1,124 +0,0 @@ -Theme | xrm-ex
-
- -
-
-
-
- -

Type alias Theme

-
Theme: "default" | "Office12Blue" | "Office14Silver"
- -
-

Remarks

getCurrentTheme() does not work with Dynamics CRM for tablets or in the unified interface.

- -

See

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Url.CmdBarDisplay.html b/docs/types/node_modules__types_xrm.Xrm.Url.CmdBarDisplay.html deleted file mode 100644 index 289b3e4..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Url.CmdBarDisplay.html +++ /dev/null @@ -1,133 +0,0 @@ -CmdBarDisplay | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Url.NavBarDisplay.html b/docs/types/node_modules__types_xrm.Xrm.Url.NavBarDisplay.html deleted file mode 100644 index 92ec70e..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Url.NavBarDisplay.html +++ /dev/null @@ -1,133 +0,0 @@ -NavBarDisplay | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/types/node_modules__types_xrm.Xrm.Url.ReportAction.html b/docs/types/node_modules__types_xrm.Xrm.Url.ReportAction.html deleted file mode 100644 index 4ffa7b7..0000000 --- a/docs/types/node_modules__types_xrm.Xrm.Url.ReportAction.html +++ /dev/null @@ -1,133 +0,0 @@ -ReportAction | xrm-ex
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/variables/node_modules__types_xrm.Window-1.html b/docs/variables/node_modules__types_xrm.Window-1.html deleted file mode 100644 index 829d7b0..0000000 --- a/docs/variables/node_modules__types_xrm.Window-1.html +++ /dev/null @@ -1,65 +0,0 @@ -Window | xrm-ex
-
- -
-
-
-
- -

Variable Window

-
Window: {
    prototype: Window;
    new (): Window;
}
-
-

Type declaration

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/variables/node_modules__types_xrm.Xrm-1.html b/docs/variables/node_modules__types_xrm.Xrm-1.html deleted file mode 100644 index 4fc558f..0000000 --- a/docs/variables/node_modules__types_xrm.Xrm-1.html +++ /dev/null @@ -1,54 +0,0 @@ -Xrm | xrm-ex
-
- -
-
-
-
- -

Variable Xrm

-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/release/xrm-ex.zip b/release/xrm-ex.zip index 3c0533ded5baf667e557fab4d946b7488b02c7b3..21b4904f01b9a4297b739f5d5bdfc459ee0738c1 100644 GIT binary patch delta 5397 zcmV+w73%80{sWi(0}N100|XQR2mlBGbTzRIUC0D$HLzHdZOAAGipLr1X(zIioX8u0 ze${x)gBnS`?B3PYxl)cbXf(PT{ch;N*_(H-&xZ?R3Vkq{@O&QY1;;GaF_#lj31vfvHQ}`&==UFB%;nXlw>YBJYH;Zx_Co-QLEtp=M zDsC1`F){gv%A=F32}=x@LQgI|22BfpCs*+*&n8or&N0@@`Hxe@M6&p1XMguNXIyOd zd;Q+o8f!wP$m7IG!0{g!V!l}u(*ZHDs5Zb+a{$LH!E&Bx*nPN9AK~Q6pwL7jop}UG zPD^cIrdW|mKN04*dRB>C1%p1TCgPo1D#807JyfO1uBjr!5EI| zY%YxSS4C3843~6_<+o5WEfd3++^oisESM0ORnkC#YHmrBPIG7luM#ZCWLO5QC^DWf zYd}^A5uAO6BA*X8oOwj4*Y;@l;eO=41#RE#_W&X|dnvSGS!NG8A8zo*j{)RZCS{Jo z1emn>a{zjQ#t{9dhAD%8>G^PD?!H9YeX)S{$Wt^>7Vu6BLLlBXnF)aS#Eq_GmstCh`uFM_j=ixvE=ogz4`dc~)T zsnw6?!;Q{}U4_-R1dkV>?2B`V=kvr<#M0+$?12 zP5FTEyAKX`8_p?F0BS%)aJCb}bBX})Y{A4FwY3#X2eG>o&1f+q1)HOem`EK(x_!d! zltkNY$SztuOay1UF+7(lw;s-s;)r{Xzn5GgT^NzI8<9(i%&PD-IVx2Hs(tDm^zF1E zJLz*U5uEMCaLf#UgZF3@$0b>kNa57!Yq5=`Ma zGE*vRJj{QKX8v1^a65)qQhqKAc+N9}if(y3%Iv3T=016UXlv0FG*BQ`2+z?Zi+|)9aFJwXN`Zey^RfMMyrq$Buu~*0hy)@$pan*1UBCBSsvDVx4JI~O)1(^M`YwZ4Bm^|CG!GB`|)`BdFWP|)#Bb@eop>DW8HP;%A zo;=)rwDoB3yYD8C_P3IB|Iv35Za>56`_aQ>Yj>aRJ=%NpXqOKBAYqOMd?L}X-Z7Lu zkbl6u$SCicVkR$RI7(A@Iq@eAGbMAEkWq#3n-?|RqRrBpj@V|wz$nG^fxos;y3`!a zLZ)!>pR!bMSdO}23C5I(u*5tsg{yYrx8jw5Wa$NE`}PP5gf<8jOjB}-;H;ZV5mIg= zUD7)9NaB9)Csq_IN}9QtKOjN;0He_xY4Bh)f}@O5i}?bkCC|)y$uS1A;5zU?H9*R> z%a$-D{wRUw8K&@wEtz&@3Pnk7bhC0vG0B*+nO_Va2xX2;Xy69C-IW?s;**ILj7Bwo zw$TV?R1-~C@QErag)>wr5;7YSz=hNAG&cIeLfWK)5E}_pd5uYQV6$%{fu&RxRog!K zO$1DzZ9c+9t3b0>6EeM-%rbddXQ&D)m7&7U-cnsoIj8YS_j{Ac1fB%i5ejA&hl8dX z`D&RA*O#`$(f}qu^m|LDprt8rxc2jZAAi7?>&N|G3o7W-I&}3t>>37Tf#E4;vrYH{ zlgV3=t*C@5P#I3CqV_eT7ZpK*v_&0U@+`B?^Qw?^j~-;6$tlY~C$d1Q69AHo6xXJC z8os!1^!+(k+6a~-9D=}0Z*$KGI{tuH#_kvnW&v!l`MBQvtkg#4s55#Gw3%@9hAY=-gj0t z6sFzxqE4fiNG$}C;-Cm;U%HR<3LM!rl5$PG>%_X-i{XP}$46F6#rE z4hM!!w+G{d#?jKM8GjpA4qqoNT7P> z{}|P+OL(Dp+PVd=uBYX6u6WwP7VRJ)C9~n+18P&Ly+=G5js8ZZ9enwJhstB}zdn*( zk0wBluhCEPHeYYCHl-^_+uXbXM4A&o44dj30G6u&L3|L1Q^(0@yTas62NkSce!xX5^sBGYKhq<1FClUaRS~X824YtL%jw^>9+k_qtVeof} zgN9e`1lDMN;hIk~92!;PW~|X1b4`UoT7U5kfOI%xnZ~C55K_mp3;VJ_VJl)+5Dy2Z zrR8lfh5@x@DFM)NrE|3X8WLub1q^Lhuq91ePNdK>!`QBRm^H3{?j+!ZdX0lIT-bk5 zM)Mca?31f_j#XwyDc^AO`d4uQ|KYlmagLfAuT5sXg-~24%KnFSaZUTWb*iZid*1>de(7i z{^X`STgnr^VM{)LcNyur7JUK3O@;?B2)9Yy?1L6dV`w>c!mZGhN;H(kUm&eHcF4WO z>jn*nH~d5cN5lQWVG~Vbp$Tq%pm)U1Jr0{PAP4AI$uG9ntn2fO)+e@BUG@}Ta*@hQ zS5*dr{Q1}9HLo{^ok=JWadB}$AR8NCL&D9TE3JM+xWp`fkvWnrR-IX2eo>O1$UH9v zby48uj8g7zm7hhRrm+bZjh$j%)zvO{CwHe2w826j(1F`AP~QL9`ay+-)Z9q5>i2eH zfM*J+9Aq|OaN{LA!LfaWs#!;UK{U`pvq0s>R1Bu&97x27xEGn&2n00c|D|Y zm9Cu=*?AKctuv%Oep*Cbl8#;h7@4w_Eu(Lr0Q7r@xBjs@zM#pLn+;Jdxjqvd1I}hV zq4^LEd@`o&7?WEF3;8|8`Q;p4x zVnTbJUm{dDW%bdTWWTrl>-vDC--~YiAz4!Is@=n+uNM~=RCYI1(&2G3g=uKw6o8=%nVI`s}#|VGhY0Z)8m#m1bkzg3Ta zlQOQe^;CBplHXUJwR2k{1|6_JP*w|*Nt29zuhI_EQ>R(3D@7j6PWuq*%XJZ)Y|V}X z?U087^@%eCGTh2ST`)`$66#K%vIc5(t@aX`^NqWtB=-&5?$(w{Z|+qa$_$%#UUHlK zN|n=NhT$eWIE0Oom+8PyDM%l# zeL8fzY7%!1r}I+3k>=+jWd<9f^CGaXde&+(f7rSf6YW6~b;;G@Ch&O|R}H3rLT2ak z2_KP3ZA08}ZK&{?BD^4>G)@XIOn=s6$oOYJ`S1ZT2Rrel%)rl7o%sdH+VOBqeNafH z_|{Y{-q6dZ7bPNP!oY>U#tX_H$Ubbku=nd-^WFPw;a(#krIwchU0gqTmTI2Bf>rKe(|695W->e|X z_|L(WyOrBz)4~#@Gwk4E^YLWz-WGxy1f~3Z2ACIS<=E;x77p!2RLpsQ5v;@BF9~OX zY)Z*iVl=f%+)FJQ(`0zXZ6{yOfN~-7zwTW_6;MLTNBjAFVP;ZYGL_o6qL8K3r?IxP z|LZ+35$-Xcd#$I|$h+%wTbKXIUdwo`%!lhSe1QcL=LfL8vo(fGo|?r0>^$6Z<-V_A z{RGR-@Vuj^M`)s?X$Sv*CwVZ6-y!o`qMAxw$8BzW8ts#OV+#QP%F5QRD2$c!jp*Q$ z(MmigSMhrHqH0?FNwHMfO25~U&5lN_G?L2Igk{-^*hM#rbT3YT9_FPWT@8-Hj7BsL zVoS+W(20^6y>=Rd&48_-!ka=)4M~v_|29u{QNxO%daV)OmvpFqS5PUc99oY$?2F8e zAj$d>0d4T&bO{JOMG3Q4N_PDOm8Ob~m79&$&=j*+>IQa4UnitNzCm2|S7>LLOWm1f z-#WqyyW?9@mp~)A)`aqFH#BqaZz}&zs{j{I9LH6@<37{hPZB9oZePl=ko+GGf>Rz) z>p(Fh)!~5R`2g&HJC4J_H`Mw6#tk!TWB^Yl{-lc#VE{q^uWq=ov=^^@fWl z_7Paa7N0nr7UnSE8#Dl{q5iL%aBac%{Kh*qPbo_h>QN2sJDS6R|BKk zKRubao4jZ=1Sl#|Y2NjEuTtwHr3RPW8fL0_W|y6qNfPz?RSMtIss% zI)H&$AZNc(2xyTRu-NV;;U_HmAe>DC59BvqD^OAB@t&l4{8E_Roq&n9Xrs!+l!|5V z+}oA4M-A6i2?9__q#J*(6P3q7Z5#W#&S<`8XrAFD*5azcf;*z}7qwn}?GfQ93Y6FO zKMI$BW?j})@RLfo2PHSI!Y|u=@?NCn3;IK+)8a3(J*7+TK&w_fL z!{P0%+c_HdhW5RG35J$zVq2juq|o$;s7jDSMJolh&iwEVhqux1n=-U5(iut+s}aVL;p>x+3YR zOjq`hK!E)~`HUZNXL4QvS4n@BDBsLbnj+q5%J}3e$kiEmh=aEpe#72^i8t-1vdi`0 zYa0P)Tj$PBg6=n(WX{?u&2XN!i{G6l!$7T|dmk--tv~K~^c>9ZOTTxFGcIffeVQzP zFlXME(L|f*wBAdqVcG#!DHy%UjJpuQA#`nYzTr>!dum{;J9X#l!#lBcUmv8{Aq0DQ z!ByYk^t%|l&3{q|I5jjK35dx^x}0Yq*cy@NDJW3ec{ZM-hezw-{+#>l;4L`NMy#tE zdbS2?n#(ON>GpG5_Fa{wwe2?D$o~g_r{rG$hqm%P9?1f)yCWMUx_|dzxPC`X_u!CK zzF{3-UN@Zu?ctx+u>6a$yRkRy- zauM1dtI#b%v0(MP=GNHSkBX_~-I&zc-=z%AK8vNR-8T+{X8L_b8aT~lQqn^OffP3 zhsvXqt1(LqmqL#(JqAq^Cs*+*&&E@Kmd-KO%lVH}#YD3BX7^z4IA>gJ_Iv%_*&3-r zrpV*OoyeUhF2sDZCZ+>oY*B51qhyf9EGE)rgUWT=4) z$hk;Iz|FTBP-_&1vkZ)cQlzM~VIl>yV1~#$xdN_fdCnBiR*<6RbK!~E+WI?NGPlLn z7L=OJF^0FL@(Wflmn3{QsvL2FnDFa(SVjiZ>OIy zF)=({K`ObJgO($>L|{B8#0t}YGC_+rktxDTmQbL8R9=b^pwOkFMJrhefOz=|T{39|}hnGnI* zR|xX?aKoublzM58_8uNYZY)UqX1@mz!P!fp4a+jS$@y@DH$DcCW0{mW3KL+`=H~$P z0*xX1PYqKB)AQlR+>Jzk+KpI1yX7ewC<}O}Bnj5}a6_Ys$|5SF|F}3>fe7JGB zSVg7A$SjZ;hF4MMCc~yXF`O((?SEn-rMo;IZtO%zL(#$y)hGCW$jw5QUX>?=-win2 zZ8#@H0jL2H!P#yM&&i_0vjr1#)K*t49dz8?XhxF}3D_KU#6;>S((N5?rzF~GLw3>P zVInx&i{ZIcxwUYP6i3{9{JrD~>B5Mty@*UoWLAZz$x*2qQ0-mspl`Pg*-4*+iQsHM zhGS+Jyho!rE=iMrL<*-)9?ypx`%%gai&U7l4AXA9z0VyK?X@90DRM9ooE^k)l%X?mC_kzfkXk(p9i+DN;DH;gVGzbQ95(CL-sp zn}@lFxewQWVLO={pq$otg+VwGORl6KP5y-`PVV^^mX&Cg$LkG7SVJv6)RLgqcfLbf zAFac7Qb|z#-o^$ry;X<_5+-1ZfJ{?_PDntorw+BG)ab)p%D}rQdE;HF!>CBbXprvm01R7EoWJWsy=>Y6f?&u zF2}h{%MA5ctK>I}HFm!jCeJpl^WWHjH783f*&w^taHsuV$OG;V&9z3O#}D@&Z9m%o z?z{1$gY6_ec=TO_JCF9G{k`dS^xdQH_M)Br?+?EJKArBR?7(qq18Ud&Z)~`?kGl`| zchhKpJAJel?SKDpKVk>TLG&=$-aBCXkM;w9(-fQ{IPKhW&1xFc$7V`y6OP-nalw$;D!F4zT z&oG5gY{|4sQ^-qlqnnvaib=+ljr?NxKqzx$LIXG8^{&*I(m9z}!PZudZEFi=loL&V zSMZ54DupvtC=yZ|V!(xy?=&|0!a~}hf)E=ClzEMabzq}!BY~xq6;;bV`9%aw!!{n_ zqLrXotqGCdOlFz9tRqwfmB>(HXK$%ar<~FFr2D<`cnnVh?Fa=ki^D-vjC{6CitAHb zI?@2fKlFP`rl2J$aJcsQk3Znc_2YhjuLTw4X&t&6537bjSYUXH*=!TOz3jzn~&?o&q{4%j;dp=^X`6i!4wLUcxaw~wvZgl zH`1KsjAtEao=TY^6CO`0g*23TW-Sa)xiX8Ctvc2pGlPEd)Ik|+t$k-jLt*Moz-wn8 zZZhMoP3kmyj?_#bE)I%-hB6nH7-wcET^@|upbg&BO8Pkxs|oC^!O?`}$^>>hrrs^2 zzzOViOg(2;6WH&Vc+Ge=frGVwnd_RqaJPQQ$;<~fZAr`vN_$z?Wqn}N;lQxz&S2CO zF*?a9TEn_CxglhJW;oCuWU#qLpoiGKf9-B-?R7W~5paxD2htrP5~$w&KSp)y5?&~t zwr;_T>uEWiE1q^7i&hYjlG$+Z0kx^b-Xk7wZT*c>JNWVsmB(a%y(hbW-WmfLzD7OC z>wLY$>Xfb^ZL#tO5J^q|F>I=D0N7In2s#IWIB^_rZF#xeg1;3^vHS*|@CR9|*k#e~ zzi@(^-Z>x}yFbW=dM6Ku!1PKaP}ySV{DTemI$2OpcLm2#B;-F!bJApNt zU%2Me42MRQxEX6S$6Qllkk%u<0FVx6EYsN3A42NR?A*RAP}q#vCB(zQX=%?k7{P$b zvJ?R5xRN<4SWW}2li+;n3$n) z$9nBfMdD#0Nd$#7kV%$e8pAu6@#O3?RbQ1W``TE|@$8fKpsf%%UYE0uOY=K7`PmYl z_zhd~xr<2GrRWQP7;ZA0z#!ZvRkJ6pBaNVC*a^2nQ!3FA7Jq>>=Z-_>EnZh>IJ{ve z8aNu}4-T7X8WT-$YXiL@cII)|zlMUb?I@5ajp2 zCaZb9IqVEViHM7f3j*2L0P7NN)?8`!Bf=$SiOi97v8v2}`t*x}^hD-)DX5A9FJ}~T zf2({i0yVWwxM-{t^D3`)u{)VNji3z{dO{oS#6WTXXKM!)7E*H~)vDjyjRBr1q;!zk zfWftwYzM~%`o2)w@9o6^uStg6!}~G7X*tcg0R{!-@l>=#ZD?C63*^#LPFHCqu_9F? z0(Cmhnk)c+TQ#VY|9dm@X(p#*>Wz$_y?yiH{mZ96e|Y)kMVzOu5>RQRLaT;0p<@C_ z9U?7Dl^`Vmu5EMwwN$;1`huvTg=T@uwW%0P%Q+B>l^I!%`r6XD(dC5((<}V<1$^_C$jw} zN?K<~Ykaqesw5q?0x&XVE1O2&-T~4>z%z>4SzH8RwPk@uKWYRy`%FY} z6Xer>l-y8{iuSi0vn--Ui@+FOA+;b=%t9ASlkVab%WbF9NZ?skYE!k%jABB2nO`DQ zH)Z9~s${>n^Xqzpq~D8f{17jxcGa$7(&)v-1*P2$BNiNZP825s*%FEc~k-zr3OEzR9uZ|~}KF|Fp}z3d}DUgg|y*o?&~oH;VS6tte1 z)4GgR8GZ8>+RFlvjnJx{-1WE~RpWx{`59OER(Js7eZUjnn6Wu=TLq=@TmJ=7h4 zh2Zyam9vyPYkteDvdw3doF8k>v^H>-euw4T&xLRvw7A{!2T1F~u2VG*6(TzqPk4`iOkx}S zhATsb*A(Fe359V|fMNQx9zn)G`_6}Vh&kAfFGU8vr|Q%%aMremW2%EfD#f>^D)EL| zKD{UrDH8@R{54)s{6P9)!-f4{@9OW~rwjKg0SUFd6zJ+AO?7CSKo4Ur;GeUbBm*7` z>6zC7`0HQcL1h=~@k%#nvr^lCvT2pk#vgHdRPZ?T=H6o>RXPj;adVfm?Q`!_Nwuqz zSvMe0D}cd|f6Vh#g|1Gfq31|>{kn8ekch-i(&@Yk!5m;bkP6~0(OobkiKl)IVR zdDFrYxHIfH#pdJj_`OX8H3$m%`3x{G%*q|Bb6YsH7f~I~vtS+eeoi=l4P;Xawi2VM zRN`K0QJW^iD{d?Kat0I&k^Ob=8Y+hpLOxp0=L<8F>XNC{`W1yNr8Xr`x>zPu5ySYiT}QkKhX|kWM~M;&#Y!V7T}@b)t?0PuT9NL>3DCp56r{_+QJAeQY6r2Us&%#Faw`Vj#w z@a%K}2t7p!y;ll$eFv4gijA3@h1O6Mvsmf^c1K+&gh9SQT-8@-W#~)Y8D`(w!V0V7 zTSAvWBbnBO;%nD5bMJ2|`%bd}7f;-Yt9Zu^)9)vV6e+hamCH_8rIJ;2Wxc{D0$`nKd$iCu6_UMer~H!2#Iv8r44kJ?7lY7|V@!3Qv)#WHD@C z_9jvD6(|(ua*20h35kfyR&VB)-r9#|Cf(6Hh3ph-WbO&uq;A7|%LNTA%e>N1zdbx;?mCdI`*a*MD10M-NTxJ547U~BYyJlO2i|2h zjDoYV>m2AhMIg&x&wzB0C1x-hk6pciI@?ad!yHfRS#bFQ@RXou92L|HE}qy&U=3Y- z;&57+!+>wl0I-Vszplcy2HX7`@6(FHL&k!4hQ}tPX}P+;oyd4TRYI*hYCie zTMby6D%5&^=Qm4$S~cwy{$5$B(@Spti7I0vy=kiK{=r3;P zZ{z}6WCkp@dP(>Ri=KqNiQ$3##%l#i3O(MFG>=~jv$q>C(GqP`nV3?s?45hNvi7Lq zx=KL+DvosH&vl~mIEZayUDqDX_YBQF9LHLxY8=6BQQ3=HuD*7QuoXGVYx|GfrCH}S zCHy3R67E6CjjQm}HXgZcZR{=s4&mT&zjr&7lQKB00-8ondbWLj$J(NAq5nDv(cFis5E#+t0%x6_lE?PAlktXKhuZw@0(BrekOjw}`GtdMeYE-6RlT z2PmHLE$&RtE8r^VuL9+p5lWNAyGqVa#r+F-opwSt7}>{z6BxV{ z2Ioi(bz20OzySo2Cw4Rxmp%q0-qSQxmS&xm8mviA(|8b+-)G(L+u^fqSMnt|s0ayv zV~t{+)A~w6oyG6s`)-r*KqaYrA5VX+U+8#z9n8R&e(xA(T-ZqdG+AKIJnN{lPIOu; zD%CLU0ILL@-iF3qh~N;q7CIaCC;Sc-Qr4Y|yUp-kZQbVtE_N`%-ekD-JDg9~!EUqT z|@h5pO(yiw}?I!~Hok-f^~I$QwSlDlFPutf{uQn8w@p zZP}SBJ+5s?Qyu?57)SRlgizkT$1+;rb+c%lRrhxwhU<6KG!G70WgE7(UJ80Mkz^%( z$CTb}Q)woAQw73TY^dK&O(9nY^e@k0Rw~PG8=n*V(S^%0(!@tU}dZ3dMre z@2gwwbKkP2(tD$0Y`@bPijEdbSJ`nC8s7B1N@{$~WKzs`0 z$L&tV)%rIX{{>J>2MCe^cy7uR006Q)002-+0|XQR2mlBG*)6j~-Qpku*)5YO{&Eep zo0(UV0(fr96aWCSlc)YFAK5LiSVByoXQm(k06Uui01f~E000000000W0Jec(lkol_ K215P-0002+wO_*k