Show / Hide Table of Contents

Method elm.GetProperties


Overload

Gets multiple properties.

public bool GetProperties(string props, out EProperties result)
Parameters
props  (string)

String that specifies properties to get, for example "nv" for name and value.

  • R - elm.Role.
  • n - elm.Name.
  • v - elm.Value.
  • d - elm.Description.
  • h - elm.Help.
  • a - elm.DefaultAction.
  • k - elm.KeyboardShortcut.
  • u - elm.UiaId.
  • U - elm.UiaCN.
  • s - elm.State.
  • r - elm.GetRect with rawtrue.
  • D - elm.Rect or elm.GetRect with rawfalse. Don't use with r.
  • w - elm.WndContainer.
  • o - elm.Html outer.
  • i - elm.Html inner.
  • @ - elm.HtmlAttributes.
result  (EProperties)

Receives results.

Returns
bool

false if failed, for example when the UI element's window is closed. Supports lastError.

Exceptions
ArgumentException

Unknown property character.

Remarks

The returned variable contains values of properties specified in props. When a property is empty or failed to get, the member variable is "", empty dictionary or default value of that type; never null.

Normally this function is faster than calling multiple property functions, because it makes single remote procedure call. But not if this UI element was found with flag EFFlags.NotInProc etc.