TdxAutomationProperty.Calculated Property

Specifies if the UIA node property value is calculated.

Declaration

property Calculated: Boolean read; write;

Property Value

Type	Description
Boolean	True The property is calculated every time a UIA client requests the corresponding property value. False The property returns the current value.

Remarks

All UIA node properties are calculated automatically if the dxUIACalculateAllProperties global variable is set to True (default). If automatic UIA property calculation is disabled, you can set the Calculated property to True within an OnInitializeProperties event handler to mark individual UIA properties as calculated.

Code Example: Calculate Only UIA Node Names for Editors

The code example in this section demonstrates an OnInitializeProperties event handler that disables automatic calculation for UIA node properties and enables calculation only for the Name UIA property. The form’s OnCreate event handler assigns the same OnInitializeProperties event handler to TcxTextEdit, TcxButtonEdit, and TcxCheckBox editors.

Delphi

uses
  dxUIAClasses,  // Declares all UI Automation classes
  cxEdit,  // Declares base editor classes and auxiliary types
  cxTextEdit,  // Declares the TcxTextEdit class
  cxCheckBox,  // Declares the TcxCheckBox class
  cxButtonEdit;  // Declares the TcxButtonEdit class
// ...

procedure TMyForm.InitializeAutomationProperties(
  ASender: TObject; AProperties: TdxAutomationProperties);
begin
  if dxUIACalculateAllProperties then
    dxUIACalculateAllProperties := False;  // Disables automatic UIA node property calculation
  AProperties.Name.Calculated := True;  // Enables calculation for the initialized Name UIA property
end;

procedure TMyForm.FormCreate(Sender: TObject);
begin
  cxTextEdit1.Properties.Automation.OnInitializeProperties := InitializeAutomationProperties;
  cxCheckBox1.Properties.Automation.OnInitializeProperties := InitializeAutomationProperties;
  cxButtonEdit1.Properties.Automation.OnInitializeProperties := InitializeAutomationProperties;
end;

C++

#include "dxUIAClasses.hpp"  // Declares all UI Automation classes
#include "cxEdit.hpp"  // Declares base editor classes and auxiliary types
#include "cxTextEdit.hpp"  // Declares the TcxTextEdit class
#include "cxCheckBox.hpp"  // Declares the TcxCheckBox class
#include "cxButtonEdit.hpp"  // Declares the TcxButtonEdit class

// Add the following linker directives to the corresponding CPP source file:
#pragma link "dxUIAClasses"  // Required to use dxUIAClasses.hpp declarations
#pragma link "cxTextEdit"  // Required to use cxTextEdit.hpp declarations
#pragma link "cxEdit" // Required to use cxEdit.hpp declarations
#pragma link "cxCheckBox"  // Required to use cxCheckBox.hpp declarations
#pragma link "cxButtonEdit"  // Required to use cxButtonEdit.hpp declarations

void __fastcall TMyForm::InitialieAutomationProperties(
  TObject *ASender, TdxAutomationProperties *AProperties)
{
  if(dxUIACalculateAllProperties)
    dxUIACalculateAllProperties = false;  // Disables automatic UIA node property calculation
  AProperties->Name->Calculated = true;  // Enables calculation for the initialized Name UIA property
}

void __fastcall TMyForm::FormCreate(TObject *Sender)
{
  cxTextEdit1->Properties->Automation->OnInitializeProperties = InitializeAutomationProperties;
  cxCheckBox1->Properties->Automation->OnInitializeProperties = InitializeAutomationProperties;
  cxButtonEdit->Properties->Automation->OnInitializeProperties = InitializeAutomationProperties;
}