Represents a NXOpen.Report.CommandBuilder . More...

Inheritance diagram for NXOpen.Report.CommandBuilder:

Public Types
enum	UserInputLocation { BeforeAutomation, AfterAutomation }
	Represents the user input location in command. More...

Public Member Functions
unsafe NXOpen.Report.BaseArgument	AddArgument (NXOpen.Report.BaseArgument.Type argumentType)
	Adds an argument and adds it to the command. More...

unsafe NXOpen.Report.UserInput	AddUserInput (NXOpen.Report.CommandBuilder.UserInputLocation userInputLocation, NXOpen.Report.UserInput.Type userInputType)
	Adds an user input and adds it to command. More...

unsafe void	GetArguments (out NXOpen.Report.BaseArgument[] pArguments)
	Gets all arguments in the command. More...

unsafe void	GetHint (out string[] commandHint)
	Gets the command hint More...

unsafe void	GetNamespaces (out string[] pNamespaces)
	Gets the categories which command apply to. More...

unsafe void	GetUserInputs (NXOpen.Report.CommandBuilder.UserInputLocation userInputLocation, out NXOpen.Report.UserInput[] pUserInputs)
	Gets all user inputs. More...

unsafe void	MoveUserInputs (NXOpen.Report.CommandBuilder.UserInputLocation userInputLocation, NXOpen.Report.UserInput[] pUserInputs, bool isBeforeRefUserInput, NXOpen.Report.UserInput pRefUserInputs)
	Moves the user inputs to the new position. More...

unsafe void	RemoveArguments (NXOpen.Report.BaseArgument[] pArguments)
	Removes the arguments. More...

unsafe void	RemoveUserInputs (NXOpen.Report.CommandBuilder.UserInputLocation userInputLocation, NXOpen.Report.UserInput[] pUserInputs)
	Removes the user inputs. More...

unsafe void	SetHint (string[] commandHint)
	Sets the command hint More...

unsafe void	SetNamespaces (string[] pNamespaces)
	Sets the categories which command apply to. More...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. 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 bool	Active `[get, set]`
	Returns or sets a value that indicates whether the command is active or not. More...

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

unsafe string	Name `[get, set]`
	Returns or sets the command name More...

unsafe NXOpen.Report.ProgramInformation	ProgramInformation `[get]`
	Returns the automation program information object. More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. 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...

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

Detailed Description

Represents a NXOpen.Report.CommandBuilder .

To create a new instance of this class, use NXOpen.Report.CommandManager.CreateCommandBuilder

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.Report.CommandBuilder.UserInputLocation

Represents the user input location in command.

Enumerator
BeforeAutomation	The user item before automation
AfterAutomation	The user item after automation

Member Function Documentation

unsafe NXOpen.Report.BaseArgument NXOpen.Report.CommandBuilder.AddArgument ( NXOpen.Report.BaseArgument.Type argumentType )

inline

Adds an argument and adds it to the command.

Created in NX11.0.0

License requirements: None.

Parameters

argumentType

Returns

unsafe NXOpen.Report.UserInput NXOpen.Report.CommandBuilder.AddUserInput	(	NXOpen.Report.CommandBuilder.UserInputLocation	userInputLocation,
		NXOpen.Report.UserInput.Type	userInputType
	)

inline

Adds an user input and adds it to command.

Created in NX11.0.0

License requirements: None.

Parameters

userInputLocation
userInputType

Returns

unsafe void NXOpen.Report.CommandBuilder.GetArguments ( out NXOpen.Report.BaseArgument[] pArguments )

inline

Gets all arguments in the command.

Created in NX11.0.0

License requirements: None.

Parameters

pArguments

unsafe void NXOpen.Report.CommandBuilder.GetHint ( out string[] commandHint )

inline

Gets the command hint

Created in NX11.0.0

License requirements: None.

Parameters

commandHint

unsafe void NXOpen.Report.CommandBuilder.GetNamespaces ( out string[] pNamespaces )

inline

Gets the categories which command apply to.

Created in NX11.0.0

License requirements: None.

Parameters

pNamespaces

unsafe void NXOpen.Report.CommandBuilder.GetUserInputs	(	NXOpen.Report.CommandBuilder.UserInputLocation	userInputLocation,
		out NXOpen.Report.UserInput[]	pUserInputs
	)

inline

Gets all user inputs.

Created in NX11.0.0

License requirements: None.

Parameters

userInputLocation
pUserInputs

unsafe void NXOpen.Report.CommandBuilder.MoveUserInputs	(	NXOpen.Report.CommandBuilder.UserInputLocation	userInputLocation,
		NXOpen.Report.UserInput[]	pUserInputs,
		bool	isBeforeRefUserInput,
		NXOpen.Report.UserInput	pRefUserInputs
	)

inline

Moves the user inputs to the new position.

Created in NX11.0.0

License requirements: None.

Parameters

userInputLocation
pUserInputs
isBeforeRefUserInput
pRefUserInputs	the target reference user input

unsafe void NXOpen.Report.CommandBuilder.RemoveArguments ( NXOpen.Report.BaseArgument[] pArguments )

inline

Removes the arguments.

Created in NX11.0.0

License requirements: None.

Parameters

pArguments

unsafe void NXOpen.Report.CommandBuilder.RemoveUserInputs	(	NXOpen.Report.CommandBuilder.UserInputLocation	userInputLocation,
		NXOpen.Report.UserInput[]	pUserInputs
	)

inline

Removes the user inputs.

Created in NX11.0.0

License requirements: None.

Parameters

userInputLocation
pUserInputs

unsafe void NXOpen.Report.CommandBuilder.SetHint ( string[] commandHint )

inline

Sets the command hint

Created in NX11.0.0

License requirements: None.

Parameters

commandHint

unsafe void NXOpen.Report.CommandBuilder.SetNamespaces ( string[] pNamespaces )

inline

Sets the categories which command apply to.

Created in NX11.0.0

License requirements: None.

Parameters

pNamespaces

Property Documentation

unsafe bool NXOpen.Report.CommandBuilder.Active

getset

Returns or sets a value that indicates whether the command is active or not.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Report.CommandBuilder.DisplayName

getset

Returns or sets the command 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.CommandBuilder.Name

getset

Returns or sets the command name

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Report.ProgramInformation NXOpen.Report.CommandBuilder.ProgramInformation

get

Returns the automation program information object.

Created in NX11.0.0

License requirements: None.

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

Report_CommandBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation