ComponentArgument Class

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

Inheritance Hierarchy

SystemObject
Autodesk.iLogic.TypesComponentArgument

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

Syntax

Public Class ComponentArgument

public class ComponentArgument

The ComponentArgument type exposes the following members.

Constructors

	Name	Description
	ComponentArgument(String)	Constructor.
	ComponentArgument(String)	Constructor
	ComponentArgument(ManagedComponentOccurrence)	Constructor.

Properties

	Name	Description
	Name	Gets the name.
	Occurrence	Gets the component occurrence.
	Path	Gets the path items.

Methods

	Name	Description
	GetComponentArgumentFromObject	Converts a general object to a ComponentArgument object.
	GetDisplayName	Gets the component name. This might be a path. This function is recommended for use only in a message.
	IsContainingAssembly	Tests to see if the component argument actually refers to the containing assembly, rather than a component within it.

Operators

	Name	Description
	(String to ComponentArgument)	Converts a name.
	(String to ComponentArgument)	Converts an array of items.
	(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.