Vcl.DBClientActns.TClientDataSetApply

From RAD Studio API Documentation
Jump to: navigation, search

Vcl.DBActns.TDataSetActionVcl.ActnList.TActionVcl.ActnList.TCustomActionSystem.Actions.TContainedActionSystem.Classes.TBasicActionSystem.Classes.TComponentSystem.Classes.TPersistentTClientDataSetApply

Delphi

TClientDataSetApply = class(TDataSetAction)

C++

class PASCALIMPLEMENTATION TClientDataSetApply : public Vcl::Dbactns::TDataSetAction

Properties

Type Visibility Source Unit Parent
class public
Vcl.DBClientActns.pas
Vcl.DBClientActns.hpp
Vcl.DBClientActns Vcl.DBClientActns

Description

TClientDataSetApply causes a target client dataset to apply the updates in its change log.

Add TClientDataSetApply to an action list or action manager to allow users to apply the updates that a client dataset caches. Controls such as menu items and tool buttons linked to this action cause the target dataset to apply the updates in its change log. If you set the DisplayErrorDlg property to true, then if the applying of updates results in errors, TClientDataSetApply displays an error dialog so that the user can indicate how to respond to those errors.

TClientDataSetApply is designed to work with a target that is a TDataSource component whose dataset is a TClientDataSet instance. You can explicitly provide this target by setting the DataSource property, or you can allow the action to infer the data source from an active data-aware control. TClientDataSetApply automatically disables itself if it does not have a target data source attached to an active client dataset.

TClientDatasetApply action automatically generates a reconcile error dialog, so you do not have to write any code to invoke the dialog. Typically, you would assign the OnReconcileError (TClientDataset ) event and write the code to invoke the dialog.

See Also