Represents an abstract command argument. More...

Inheritance diagram for NXOpen.Report.BaseArgument:

Public Types
enum	Type { Integer, Double, String, Enumeration }
	Represents the argument type. More...

Public Member Functions
unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe void	Print ()
	Prints a representation of this object to the system log file. More...

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe string	DisplayName `[get, set]`
	Returns or sets the argument display name More...

unsafe string	Hint `[get, set]`
	Returns or sets the argument hint. More...

unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe bool	Optional `[get, set]`
	Returns or sets a value that indicates whether this argument is optional or not. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Properties inherited from NXOpen.INXObject
bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

string	Name `[get]`
	Returns the custom name of the object. More...

NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents an abstract command argument.

Not support KF.

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.Report.BaseArgument.Type

Represents the argument type.

Enumerator
Integer	Argument for integer data
Double	Argument for double data
String	Argument for string data
Enumeration	Argument for enumeration data

Member Function Documentation

unsafe NXOpen.INXObject NXOpen.Report.BaseArgument.FindObject ( string journalIdentifier )

inline

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Created in NX3.0.0

License requirements: None.

Parameters

journalIdentifier Journal identifier of the object

Returns

Implements NXOpen.INXObject.

unsafe void NXOpen.Report.BaseArgument.Print ( )

inline

Prints a representation of this object to the system log file.

Created in NX3.0.0

License requirements: None.

Implements NXOpen.INXObject.

unsafe void NXOpen.Report.BaseArgument.SetName ( string name )

inline

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

License requirements: None.

Parameters

name

Implements NXOpen.INXObject.

Property Documentation

unsafe string NXOpen.Report.BaseArgument.DisplayName

getset

Returns or sets the argument display name

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Report.BaseArgument.Hint

getset

Returns or sets the argument hint.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Report.BaseArgument.IsOccurrence

get

Returns whether this object is an occurrence or not.

Created in NX3.0.0

License requirements: None.

unsafe string NXOpen.Report.BaseArgument.JournalIdentifier

get

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

Created in NX3.0.0

License requirements: None.

unsafe string NXOpen.Report.BaseArgument.Name

get

Returns the custom name of the object.

Created in NX3.0.0

License requirements: None.

unsafe bool NXOpen.Report.BaseArgument.Optional

getset

Returns or sets a value that indicates whether this argument is optional or not.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Assemblies.Component NXOpen.Report.BaseArgument.OwningComponent

get

Returns the owning component, if this object is an occurrence.

Created in NX3.0.0

License requirements: None.

unsafe NXOpen.BasePart NXOpen.Report.BaseArgument.OwningPart

get

Returns the owning part of this object

Created in NX3.0.0

License requirements: None.

unsafe NXOpen.INXObject NXOpen.Report.BaseArgument.Prototype

get

Returns the prototype of this object if it is an occurrence.

Created in NX3.0.0

License requirements: None.

The documentation for this class was generated from the following file:

Report_BaseArgument.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation