NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.CAM.WorkInstructionOutputBuilder Class Reference

Represents the builder for Work Instruction Output. More...

Inheritance diagram for NXOpen.CAM.WorkInstructionOutputBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  OutputFormatType { Html, Pdf, Csv, Xml }
 the output format type More...
 
enum  PageOrientationType { Landscape, Portrait }
 the page orientation type More...
 
enum  PageSizeType {
  A0, A1, A2, A3,
  A4, B1, B2, B3,
  B4, B5, Executive, Folio,
  Legal, Letter, Tabloid
}
 the page size type More...
 

Public Member Functions

unsafe void Publish (NXOpen.CAM.CAMObject[] objects, NXOpen.CAM.CAMObject firstSelObj, int currentView)
 Publish the Work Instructions 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 OpenFile [get, set]
 Returns or sets the open file More...
 
unsafe string OutputFile [get, set]
 Returns or sets the output file More...
 
unsafe
NXOpen.CAM.WorkInstructionOutputBuilder.OutputFormatType 
OutputFormat [get, set]
 Returns or sets the output format More...
 
unsafe
NXOpen.CAM.WorkInstructionOutputBuilder.PageOrientationType 
PageOrientation [get, set]
 Returns or sets the page orientation More...
 
unsafe
NXOpen.CAM.WorkInstructionOutputBuilder.PageSizeType 
PageSize [get, set]
 Returns or sets the page size More...
 
unsafe double ScaleFactor [get, set]
 Returns or sets the scale factor 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 Output.

This class is used to publish work instructions for the end user.

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

Created in NX9.0.3

Member Enumeration Documentation

the output format type

Enumerator
Html 
Pdf 
Csv 
Xml 

the page orientation type

Enumerator
Landscape 
Portrait 

the page size type

Enumerator
A0 
A1 
A2 
A3 
A4 
B1 
B2 
B3 
B4 
B5 
Executive 
Folio 
Legal 
Letter 
Tabloid 

Member Function Documentation

unsafe void NXOpen.CAM.WorkInstructionOutputBuilder.Publish ( NXOpen.CAM.CAMObject[]  objects,
NXOpen.CAM.CAMObject  firstSelObj,
int  currentView 
)
inline

Publish the Work Instructions

Created in NX9.0.3

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

Parameters
objectsarray of objects
firstSelObj
currentViewCAM_SETUP_view

Property Documentation

unsafe bool NXOpen.CAM.WorkInstructionOutputBuilder.OpenFile
getset

Returns or sets the open file

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.WorkInstructionOutputBuilder.OutputFile
getset

Returns or sets the output file

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 NXOpen.CAM.WorkInstructionOutputBuilder.OutputFormatType NXOpen.CAM.WorkInstructionOutputBuilder.OutputFormat
getset

Returns or sets the output format

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 NXOpen.CAM.WorkInstructionOutputBuilder.PageOrientationType NXOpen.CAM.WorkInstructionOutputBuilder.PageOrientation
getset

Returns or sets the page orientation

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 NXOpen.CAM.WorkInstructionOutputBuilder.PageSizeType NXOpen.CAM.WorkInstructionOutputBuilder.PageSize
getset

Returns or sets the page 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 double NXOpen.CAM.WorkInstructionOutputBuilder.ScaleFactor
getset

Returns or sets the scale factor

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")


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.