TdxAutomationProperties.FullDescription Property

Stores a detailed (optional) description for the processed UIA node.

Declaration

property FullDescription: TdxStringAutomationProperty read;

Property Value

Type	Description
TdxStringAutomationProperty	The UIA node description.

Remarks

You can use Name and FullDescription properties to modify the current UIA node name and description in OnCalculateProperty and OnInitializeProperties event handlers.

Code Examples

Initialize UIA Node Names for Editors

The following code example initializes Name and FullDescription UIA node names for an existing single-line text editor (TcxTextEdit):

Delphi

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

procedure TMyForm.cxTextEdit1PropertiesAutomationCalculateProperty(
  ASender: TObject; AProperties: TdxAutomationProperties);
begin
  AProperties.Name.Value := 'Task Description';
  AProperties.FullDescription.Value := 'Non-Editable';
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

// 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

void __fastcall TMyForm::cxTextEdit1PropertiesAutomationCalculateProperty(
  TObject *ASender, TdxAutomationProperties *AProperties)
{
  AProperties->Name->Value = "Task Description";
  AProperties->FullDescription->Value = "Non-Editable";
}

Indicate Read-Only and Editable States

The code example in this section changes the description of an unbound single-line text editor (TcxTextEdit) in the UI Automation tree when the editor switches between read-only and editable states.

Delphi

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

procedure TMyForm.cxTextEdit1PropertiesAutomationCalculateProperty(
  ASender: TObject; AProperty: TdxAutomationProperty;
  AProperties: TdxAutomationProperties);
var
  AEdit: TcxTextEdit;
begin
  AEdit := ASender as TcxTextEdit;
  // Check if the UIA node description property is requested
  if AProperty = AProperties.FullDescription then
  begin
    if AEdit.Properties.ReadOnly then
      AProperties.FullDescription.Value := 'Read-Only Mode'
    else
      AProperties.FullDescription.Value := 'Editable';
  end;
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

// 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

void __fastcall TMyForm::cxTextEdit1PropertiesAutomationCalculateProperty(
  TObject *ASender, TdxAutomationProperty *AProperty,
  TdxAutomationProperties *AProperties)
{
  TcxTextEdit *AEdit = dynamic_cast<TcxTextEdit*>(ASender);
  // Check if the UIA node description property is requested
  if(AProperty == AProperties->FullDescription)
  {
    if(AEdit->Properties->ReadOnly)
      AProperties->FullDescription->Value = "Read-Only Mode";
    else
      AProperties->FullDescription->Value = "Editable";
  }
}