Keysight Pathwave 89600 VSA .NET API
MacroCollection Class Members
See Also  Properties  Methods  Events
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace : MacroCollection Class

Glossary Item Box

The following tables list the members exposed by MacroCollection.

Public Properties

 NameDescriptionMinimum SW Version
Public PropertyAvailableMacroLanguagesGets the list of currently supported macro recording languages.  
Public PropertyCountGets the number of items in the collection. (Inherited from Agilent.SA.Vsa.RemotableCollection<Macro>)
Public PropertyDirectoryPathGets the macros directory path.  27.00
Public PropertyDotNetVersionGets or sets the .NET Software Development Kit (SDK) version to use when recording or creating new macros.  29.00
Public PropertyIsDisposedGets a value indicating whether the object has been disposed. If an object has been disposed any attempt to use it will lead to an ObjectDisposedException being thrown. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public PropertyItemOverloaded. Returns the named macro from the collection.  
Public PropertyRecordingLanguageGets or sets the language used when a new macro is recorded or created.  
Public PropertySelectedIndexGets or sets the index of the current macro.  
Public PropertySelectedItemGets or sets the current macro.  
Public PropertySupportsDotNetGets or sets a value indicating whether new or recorded macros should support .NET 6.0 or greater.  29.00
Public PropertySupportsDotNetFrameworkGets or sets a value indicating whether new or recorded macros should support .NET Framework.  29.00
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Methods

 NameDescriptionMinimum SW Version
Public MethodCreateOverloaded. Create a new, empty macro.  
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodForceRebuildKeyMapThis method is used to force a refresh of the key map. This is necessary in cases where the key mappings to the API objects change. This can happen when the index of an item within a collection is reflected in the key name, and an item is removed from the middle of a collection. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodGetEnumeratorGets an enumerator for the collection. (Inherited from Agilent.SA.Vsa.RemotableCollection<Macro>)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodIndexOfOverloaded. Gets the index location of the specified item within the collection. (Inherited from Agilent.SA.Vsa.RemotableCollection<Macro>)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodRemoveRemove a macro from the collection.  
Public MethodRemoveAtRemove a macro from the collection.  
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Events

 NameDescriptionMinimum SW Version
Public EventCollectionChangedOccurs when an item is added, removed, changed, moved, or the entire list is refreshed. (Inherited from Agilent.SA.Vsa.RemotableCollection<Macro>)
Public EventPropertyChangedOccurs when a property value changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventPropertyInfoChangedOccurs when secondary information about a property, such as limits, changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventRemoteCollectionChangedOccurs when an item is added, removed, changed, moved, or the entire list is refreshed. (Inherited from Agilent.SA.Vsa.RemotableCollection<Macro>)14.00
Public EventRemotePropertyChangedOccurs when a property value changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventRemotePropertyInfoChangedOccurs when secondary information about a property, such as limits, changes. (Inherited from Agilent.SA.Vsa.RemotableObject)14.00
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

See Also