Power Apps component framework API reference

This section contains reference documentation for creating code components using the Power Apps component framework.

Important

  • The Available for tab shows which APIs are supported by model-driven and canvas apps. It is recommended to check the Available for section for each individual API methods whether it is supported or not.

  • Using the Xrm object methods that are not exposed by the framework for developing code components is not supported.

Name Description Available for
AttributeMetadata Provides all the information about attributes/columns definitions. Canvas apps
Client Provides access to the methods to determine which client is being used, whether the client is connected to server, and what kind of device is being used. Model-driven and canvas apps
Column Provides information about the column metadata in a dataset. Model-driven and canvas apps
ConditionExpression Provides a expression used to filter the result of the query. Model-driven apps
Context Provides all the properties and methods available in the Power Apps component framework. Model-driven and canvas apps
ControlAttributes Attributes/columns of the control that are necessary for formatting. Model-driven and canvas apps
ControlAttributesType Enumeration of the control attribute/column type. Model-driven and canvas apps
DataProviderCapabilities Provides access to all the properties of a file. Canvas apps
DataSet Provides properties and methods to work with data on grids and views. Model-driven and canvas apps
DateFormattingInfo Provides the date formatting information for the current user. Model-driven apps
DateTimeFieldBehavior The behavior of the datetime object to be formatted. Model-driven apps
Device Provides methods to use native device capabilities. Model-driven and canvas apps
Entity Provides properties and methods to work with data on a table. Model-driven apps
EntityFormOptions Provides access to all the information about the table forms. Model-driven apps
EntityRecord Base interface for dataset record result. Supports value retrieval by column name. Model-driven and canvas apps
EntityReference An object that encapsulates a table/entity reference as a plain object suitable for storing in the state tree. Model-driven apps
Factory Provides properties and methods to work with Popup services. Model-driven and canvas apps
FileObject Provides access to all the properties of a file. Model-driven apps
FilterExpression An expression used to represent a filter. Model-driven apps
Filtering Provides properties and methods for filtering in a dataset. Model-driven and canvas apps
Formatting Provides properties and methods to work with formatting. Model-driven and canvas apps
ICommand A command button control types. Model-driven and canvas apps
Linking Provides properties and methods to determine which table is linked and to get all the tables linked. Model-driven apps
Metadata Provides all the information about column definitions. Model-driven apps
Mode Provides access to methods to get the information about the current state of the code component. Model-driven and canvas apps
MoneyPrecisionSource Enumeration for money precision source. These should match the MoneyPrecisionSource enumeration in Microsoft.Xrm.Sdk.Metadata. Model-driven and canvas apps
Navigation Provides navigation-related methods. Model-driven and canvas apps
NumberFormattingInfo The interface for the Organization System Settings Number Format info exposed to a code component. Model-driven apps
OptionDescriptor Optionset/choice object of the attribute/column. Model-driven and canvas apps
Paging Provides properties and methods to work with paging. Model-driven and canvas apps
Popup Provides access to get all the information about the popup. Model-driven apps
PopupService Provides properties and methods to create and manage popups. Model-driven and canvas apps
Position Provides access to get geographical information from context.device.getCurrentPosition method. Model-driven and canvas apps
Property Interface for context.parameters.<property_key> Model-driven and canvas apps
ReactControl (Preview) Provides properties and methods to initiate, update, destroy and perform various actions to build a component using a React control.This control is part of the React controls & platform libraries (Preview) . Model-driven and canvas apps
Resources Provides access to the methods to get all the information about the resource files defined in the manifest. Model-driven and canvas apps
RetrieveMultipleResponse The response from webAPI.retrieveMultipleRecords Model-driven apps
Security Values Provides all the information about table definitions security values. Model-driven apps
SortStatus Current sort status of a dataset column. Model-driven apps
StandardControl Provides properties and methods to initiate, update, destroy and perform various actions to build a component. Model-driven and canvas apps
updatedProperties Provides information on what has changed in the updateView method. The information could be change in the property value, component or browser resize event. Model-driven and canvas apps
UserSettings Provides information about the current user settings. Model-driven and canvas apps
Utility Provides a container for useful methods. Model-driven apps
WebApi Provides properties and methods to use Web API to create and manage records. Model-driven apps