Represents the builder for Work Instruction More...

Inheritance diagram for NXOpen.CAM.WorkInstructionBuilder:

Public Member Functions
unsafe void	ActivateCapturedView ()
	Activate the captured view for a view item More...

unsafe int	AddSheet ()
	Add a Work Instruction sheet More...

unsafe void	CaptureCurrentView ()
	Capture the current view using a new camera More...

unsafe void	CommitItem ()
	Commit the current item More...

unsafe void	CommitMaster ()
	Commit the current master More...

unsafe void	DeleteSheet (int sheetNum)
	Delete a Work Instruction sheet More...

unsafe void	DeleteViewCamera ()
	Delete the view camera More...

unsafe string[]	GetRichText ()
	Returns the multi line text More...

unsafe double[]	GetTextColor ()
	Returns the text color More...

unsafe void	MoveSheet (int sheetNum, bool up)
	Move a Work Instruction sheet More...

unsafe void	RestorePreviousView ()
	Restore the previous view More...

unsafe void	SetRichText (string[] multiLineText)
	Sets the multi line text More...

unsafe void	SetTextColor (double[] textColor)
	Sets the text color More...

unsafe void	SetToolDisplayMotion (int eventType, int eventIndex)
	Sets the tool display path event type and index More...

unsafe void	SpecifyDrawingSheet (string partName, string drawingName)
	Specify a drawing sheet in a component More...

unsafe void	UpdateItemsInCurrentSheet (string[] itemNames)
	Update the items for the current sheet 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 string	CameraName `[get, set]`
	Returns or sets the selected camera More...

unsafe string	Drawing `[get, set]`
	Returns or sets the selected drawing More...

unsafe NXOpen.NXObject	DrawingSheet `[get, set]`
	Returns or sets the selected drawing sheet More...

unsafe string	FontFace `[get, set]`
	Returns or sets the text font face More...

unsafe int	FontSize `[get, set]`
	Returns or sets the text font size More...

unsafe string	ImageFile `[get, set]`
	Returns or sets the selected image More...

unsafe string	ItemName `[get, set]`
	Returns or sets the work instruction item name More...

unsafe bool	NoBackground `[get, set]`
	Returns or sets the no background option More...

unsafe string	OperListProgramGroup `[get, set]`
	Returns or sets the selected Program Group for Operation List More...

unsafe int	SheetNumber `[get, set]`
	Returns or sets the work instruction sheet number More...

unsafe string	SheetTitle `[get, set]`
	Returns or sets the user defined Sheet Title More...

unsafe string	TemplateName `[get, set]`
	Returns or sets the template name More...

unsafe double	TimeEstimate `[get, set]`
	Returns or sets the estimated time to execute these instructions More...

unsafe string	ToolListProgramGroup `[get, set]`
	Returns or sets the selected Program Group for Tool List More...

unsafe string	ToolSetupSheet `[get, set]`
	Returns or sets the selected tool setup sheet More...

unsafe string	VideoFile `[get, set]`
	Returns or sets the selected video More...

unsafe bool	ViewTool `[get, set]`
	Returns or sets the show tool option 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 the builder for Work Instruction

To create a new instance of this class, use NXOpen.CAM.CAMSetup.CreateWorkInstructionBuilder

Created in NX9.0.3

Member Function Documentation

unsafe void NXOpen.CAM.WorkInstructionBuilder.ActivateCapturedView ( )

inline

Activate the captured view for a view item

Created in NX9.0.3

License requirements: None.

unsafe int NXOpen.CAM.WorkInstructionBuilder.AddSheet ( )

inline

Add a Work Instruction sheet

Created in NX9.0.3

License requirements: nx_wi_authoring (" NX Work Instruction Authoring")

Returns

unsafe void NXOpen.CAM.WorkInstructionBuilder.CaptureCurrentView ( )

inline

Capture the current view using a new camera

Created in NX9.0.3

License requirements: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe void NXOpen.CAM.WorkInstructionBuilder.CommitItem ( )

inline

Commit the current item

Created in NX9.0.3

License requirements: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe void NXOpen.CAM.WorkInstructionBuilder.CommitMaster ( )

inline

Commit the current master

Created in NX9.0.3

License requirements: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe void NXOpen.CAM.WorkInstructionBuilder.DeleteSheet ( int sheetNum )

inline

Delete a Work Instruction sheet

Created in NX9.0.3

License requirements: nx_wi_authoring (" NX Work Instruction Authoring")

Parameters

sheetNum

unsafe void NXOpen.CAM.WorkInstructionBuilder.DeleteViewCamera ( )

inline

Delete the view camera

Created in NX9.0.3

License requirements: None.

unsafe string [] NXOpen.CAM.WorkInstructionBuilder.GetRichText ( )

inline

Returns the multi line text

Created in NX9.0.3

License requirements: None.

Returns

unsafe double [] NXOpen.CAM.WorkInstructionBuilder.GetTextColor ( )

inline

Returns the text color

Created in NX9.0.3

License requirements: None.

Returns: Array of 3 RGB values, each between 0 and 1

unsafe void NXOpen.CAM.WorkInstructionBuilder.MoveSheet	(	int	sheetNum,
		bool	up
	)

inline

Move a Work Instruction sheet

Created in NX9.0.3

License requirements: nx_wi_authoring (" NX Work Instruction Authoring")

Parameters

sheetNum
up

unsafe void NXOpen.CAM.WorkInstructionBuilder.RestorePreviousView ( )

inline

Restore the previous view

Created in NX9.0.3

License requirements: None.

unsafe void NXOpen.CAM.WorkInstructionBuilder.SetRichText ( string[] multiLineText )

inline

Sets the multi line text

Created in NX9.0.3

License requirements: nx_wi_authoring (" NX Work Instruction Authoring")

Parameters

multiLineText

unsafe void NXOpen.CAM.WorkInstructionBuilder.SetTextColor ( double[] textColor )

inline

Sets the text color

Created in NX9.0.3

License requirements: nx_wi_authoring (" NX Work Instruction Authoring")

Parameters

textColor Array of 3 RGB values, each between 0 and 1

unsafe void NXOpen.CAM.WorkInstructionBuilder.SetToolDisplayMotion	(	int	eventType,
		int	eventIndex
	)

inline

Sets the tool display path event type and index

Created in NX11.0.1

License requirements: nx_wi_authoring (" NX Work Instruction Authoring")

Parameters

eventType	the path event type
eventIndex	the path event index

unsafe void NXOpen.CAM.WorkInstructionBuilder.SpecifyDrawingSheet	(	string	partName,
		string	drawingName
	)

inline

Specify a drawing sheet in a component

Created in NX11.0.1

License requirements: None.

Parameters

partName
drawingName

unsafe void NXOpen.CAM.WorkInstructionBuilder.UpdateItemsInCurrentSheet ( string[] itemNames )

inline

Update the items for the current sheet

Created in NX9.0.3

License requirements: cam_base ("CAM BASE")

Parameters

itemNames the string array

Property Documentation

unsafe string NXOpen.CAM.WorkInstructionBuilder.CameraName

getset

Returns or sets the selected camera

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe string NXOpen.CAM.WorkInstructionBuilder.Drawing

getset

Returns or sets the selected drawing

Created in NX9.0.3

Deprecated in NX11.0.1. Use CAM.WorkInstructionBuilder.DrawingSheet instead.

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe NXOpen.NXObject NXOpen.CAM.WorkInstructionBuilder.DrawingSheet

getset

Returns or sets the selected drawing sheet

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe string NXOpen.CAM.WorkInstructionBuilder.FontFace

getset

Returns or sets the text font face

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe int NXOpen.CAM.WorkInstructionBuilder.FontSize

getset

Returns or sets the text font size

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe string NXOpen.CAM.WorkInstructionBuilder.ImageFile

getset

Returns or sets the selected image

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe string NXOpen.CAM.WorkInstructionBuilder.ItemName

getset

Returns or sets the work instruction item name

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe bool NXOpen.CAM.WorkInstructionBuilder.NoBackground

getset

Returns or sets the no background option

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe string NXOpen.CAM.WorkInstructionBuilder.OperListProgramGroup

getset

Returns or sets the selected Program Group for Operation List

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe int NXOpen.CAM.WorkInstructionBuilder.SheetNumber

getset

Returns or sets the work instruction sheet number

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe string NXOpen.CAM.WorkInstructionBuilder.SheetTitle

getset

Returns or sets the user defined Sheet Title

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe string NXOpen.CAM.WorkInstructionBuilder.TemplateName

getset

Returns or sets the template name

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe double NXOpen.CAM.WorkInstructionBuilder.TimeEstimate

getset

Returns or sets the estimated time to execute these instructions

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe string NXOpen.CAM.WorkInstructionBuilder.ToolListProgramGroup

getset

Returns or sets the selected Program Group for Tool List

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe string NXOpen.CAM.WorkInstructionBuilder.ToolSetupSheet

getset

Returns or sets the selected tool setup sheet

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe string NXOpen.CAM.WorkInstructionBuilder.VideoFile

getset

Returns or sets the selected video

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

unsafe bool NXOpen.CAM.WorkInstructionBuilder.ViewTool

getset

Returns or sets the show tool option

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_wi_authoring (" NX Work Instruction Authoring")

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

CAM_WorkInstructionBuilder.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation