Share

ComponentArgument Class

Wrapper for a component occurrence, occurrence name, or occurrence path based on occurrence names.

Inheritance Hierarchy

System.Object
  Autodesk.iLogic.Types.ComponentArgument

Namespace:  Autodesk.iLogic.Types
Assembly:  Autodesk.iLogic.Types (in Autodesk.iLogic.Types.dll) Version: 30.0

Syntax

VB

Public Class ComponentArgument

C#

public class ComponentArgument

The ComponentArgument type exposes the following members.

Constructors

Properties

  NameDescription
Public propertyName
Gets the name.
Public propertyOccurrence
Gets the component occurrence.
Public propertyPath
Gets the path items.

Methods

  NameDescription
Public methodStatic memberGetComponentArgumentFromObject
Converts a general object to a ComponentArgument object.
Public methodStatic memberGetDisplayName
Gets the component name. This might be a path. This function is recommended for use only in a message.
Public methodStatic memberIsContainingAssembly
Tests to see if the component argument actually refers to the containing assembly, rather than a component within it.

Operators

  NameDescription
Public operatorStatic memberImplicit(String to ComponentArgument)
Converts a name.
Public operatorStatic memberImplicit( String[] to ComponentArgument)
Converts an array of items.
Public operatorStatic memberImplicit(ManagedComponentOccurrence to ComponentArgument)
Converts a component occurrence.

Remarks

An object of this type can hold one of:
  • A single component name (e.g.: "Part:1").
  • A path to a component in a subassembly (e.g.: {"Subassembly:1", "Part:1"})
  • An empty string (or Nothing). This refers not to a component of the assembly, but rather to the assembly itself.
  • A ManagedComponentOccurrence object.

See Also

Reference

Was this information helpful?