Active Property

Summary

Gets or sets a value indicating whether this AnnAutomation is active.

Syntax

Java

Objective-C

WinRT C#

C++

public virtual bool Active { get; set; }

Public Overridable Property Active As Boolean

public virtual bool Active {get; set;}

@property (nonatomic) BOOL active;

public boolean getActive() 
public void setActive(boolean active)

 <br/>get_Active();<br/>set_Active(value);<br/>Object.defineProperty('Active');

public:  
   virtual property bool Active 
   { 
      bool get() 
      void set(bool value) 
   }

Property Value

true if this AnnAutomation is active; otherwise, it is false.

Remarks

The collection of AnnAutomation objects inside a AnnAutomationManager should have one AnnAutomation object active at any time. The active AnnAutomation object is the object to which all user interface actions are directed.

If the automated annotation application has only one AnnAutomation object, it should set the Active property of this AnnAutomation to true upon initialization. Otherwise, set the Active property of the active AnnAutomation to true.

If the automated annotation application has more than one AnnAutomation, it should set the Active property of the AnnAutomation attached to the currently active form to true.

Setting the Active value of one AnnAutomation in the Automations property to true, will cause the Active property of all other AnnAutomation objects inside this collection to be set to false.

Example

For an example, refer to FindObjectById.

Requirements

Target Platforms