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 apps and canvas apps (public preview). It is recommended to check the Available for section for each individual API methods whether it is supported or not. For example, the client API is supported for both model-driven apps and canvas apps, but the isOffline method in client API supports only model-driven apps.

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

Name Description Available for
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 apps and canvas apps (public preview)
Column Provides information about the column metadata in a data-set. Model-driven apps and canvas apps (public preview)
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 apps and canvas apps (public preview)
DataSet Provides properties and methods to work with data on grids and views. Model-driven apps and canvas apps (public preview)
DateFormattingInfo Provides the date formatting information for the current user. Model-driven apps
Device Provides methods to use native device capabilities. Model-driven apps and canvas apps (public preview)
EntityRecord Base interface for data-set record result. Supports value retrieval by column name. Model-driven 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 apps and canvas apps (public preview)
Filtering Provides properties and methods for filtering in a data-set. Model-driven apps
Formatting Provides properties and methods to work with formatting. Model-driven apps and canvas apps (public preview)
Linking Provides properties and methods to determine which table is linked and to get all the tables linked. Model-driven apps
Mode Provides access to methods to get the information about the current state of the code component. Model-driven apps
Navigation Provides navigation-related methods. Model-driven apps
NumberFormattingInfo The interface for the Organization System Settings Number Format info exposed to a code component. Model-driven apps
Paging Provides properties and methods to work with paging. Model-driven 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 apps and canvas apps (public preview)
Resources Provides access to the methods to get all the information about the resource files defined in the manifest. Model-driven apps
SortStatus Current sort status of a data-set column. Model-driven apps
StandardControl Provides properties and methods to initiate, update, destroy and perform various actions to build a component. Model-driven apps and canvas apps (public preview)
UserSettings Provides information about the current user settings. Model-driven 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

Note

Can you tell us about your documentation language preferences? Take a short survey.

The survey will take about seven minutes. No personal data is collected (privacy statement).