nxopen.drawings

Interface DrawingSheetBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

All Known Subinterfaces:

ConvertSheetToLayoutBuilder, DraftingDrawingSheetBuilder, LayoutDrawingSheetBuilder

public interface DrawingSheetBuilder
extends Builder

Represents a DrawingSheetBuilder
This class was made abstract in NX12 and the creator (JA_DRAWING_SHEET_COLLECTION_drawing_sheet_builder) was deprecated

Created in NX5.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DrawingSheetBuilder.SheetBaseordrawingView the base view or drawing view option
static class	DrawingSheetBuilder.SheetMode the drawing sheet dialog mode
static class	DrawingSheetBuilder.SheetOption the options for specifying the attributes of the new drawing sheet to be created.
static class	DrawingSheetBuilder.SheetProjectionAngle the drawing sheet projection angle
static class	DrawingSheetBuilder.SheetStandardEnglishScale the standard English drawing sheet scales
static class	DrawingSheetBuilder.SheetStandardMetricScale the standard Metric drawing sheet scales
static class	DrawingSheetBuilder.SheetUnits the drawing sheet units

Method Summary

Modifier and Type	Method and Description
boolean	autoStartBaseView() Deprecated. Deprecated in NX7.5.0. Use autoStartViewCreation() instead.
boolean	autoStartViewCreation() Returns the setting that controls whether or not the Add View creation is automatically started after inserting a sheet that has no views on it.
DrawingSheetBuilder.SheetBaseordrawingView	baseordrawingView() Returns the option of base view or drawing view License requirements: None.
String	englishSheetTemplateLocation() Returns the location of the english drawing sheet template to be added to the part file License requirements: None.
double	height() Returns the custom or standard height for the drawing sheet License requirements: None.
double	length() Returns the custom or standard length to be used for the drawing to be created or edited.
String	metricSheetTemplateLocation() Returns the location of the metric drawing sheet template to be added to the part file License requirements: None.
String	name() Returns the name of the drawing sheet to be created or edited License requirements: None.
String	number() Returns the number of the drawing sheet to be created or edited License requirements: None.
DrawingSheetBuilder.SheetOption	option() Returns the option to be used to create the drawing sheet License requirements: None.
DrawingSheetBuilder.SheetProjectionAngle	projectionAngle() Returns the projection_angle option License requirements: None.
String	revision() Returns the revision of the drawing sheet to be created or edited License requirements: None.
double	scaleDenominator() Returns the denominator of a custom scale License requirements: None.
double	scaleNumerator() Returns the numerator of a custom scale License requirements: None.
String	secondaryNumber() Returns the secondary number of the drawing sheet to be created or edited License requirements: None.
void	setAutoStartBaseView(boolean autoStartBaseView) Deprecated. Deprecated in NX7.5.0. Use setAutoStartViewCreation(boolean) instead.
void	setAutoStartViewCreation(boolean autoStartViewCreation) License requirements: None.
void	setBaseordrawingView(DrawingSheetBuilder.SheetBaseordrawingView option) License requirements: drafting ("DRAFTING") .
void	setEnglishSheetTemplateLocation(String englishSheetTemplateLocation) License requirements: drafting ("DRAFTING") .
void	setHeight(double height) License requirements: drafting ("DRAFTING") .
void	setLength(double length) License requirements: drafting ("DRAFTING") .
void	setMetricSheetTemplateLocation(String metricSheetTemplateLocation) License requirements: drafting ("DRAFTING") .
void	setName(String name) License requirements: drafting ("DRAFTING") .
void	setNumber(String number) License requirements: drafting ("DRAFTING") .
void	setOption(DrawingSheetBuilder.SheetOption option) License requirements: drafting ("DRAFTING") .
void	setProjectionAngle(DrawingSheetBuilder.SheetProjectionAngle projectionAngle) License requirements: drafting ("DRAFTING") .
void	setRevision(String revision) License requirements: drafting ("DRAFTING") .
void	setScaleDenominator(double scaleDenominator) License requirements: drafting ("DRAFTING") .
void	setScaleNumerator(double scaleNumerator) License requirements: drafting ("DRAFTING") .
void	setSecondaryNumber(String secondaryNumber) License requirements: drafting ("DRAFTING") .
void	setStandardEnglishScale(DrawingSheetBuilder.SheetStandardEnglishScale englishScale) License requirements: drafting ("DRAFTING") .
void	setStandardMetricScale(DrawingSheetBuilder.SheetStandardMetricScale metricScale) License requirements: drafting ("DRAFTING") .
void	setUnits(DrawingSheetBuilder.SheetUnits units) License requirements: drafting ("DRAFTING") .
DrawingSheetBuilder.SheetStandardEnglishScale	standardEnglishScale() Returns the standard English drawing scale License requirements: None.
DrawingSheetBuilder.SheetStandardMetricScale	standardMetricScale() Returns the standard Metric drawing scale License requirements: None.
DrawingSheetBuilder.SheetUnits	units() Returns the units for the drawing sheet License requirements: None.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

name

String name()
     throws NXException,
            RemoteException

Returns the name of the drawing sheet to be created or edited
License requirements: None.

Created in NX5.0.0

Returns:

the drawing sheet name

Throws:

NXException

RemoteException

setName

void setName(String name)
      throws NXException,
             RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

name - drawing sheet name

Throws:

NXException

RemoteException

number

String number()
       throws NXException,
              RemoteException

Returns the number of the drawing sheet to be created or edited
License requirements: None.

Created in NX8.0.0

Returns:

the drawing sheet number

Throws:

NXException

RemoteException

setNumber

void setNumber(String number)
        throws NXException,
               RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX8.0.0

Parameters:

number - the drawing sheet number

Throws:

NXException

RemoteException

secondaryNumber

String secondaryNumber()
                throws NXException,
                       RemoteException

Returns the secondary number of the drawing sheet to be created or edited
License requirements: None.

Created in NX8.0.0

Returns:

the drawing sheet secondary number

Throws:

NXException

RemoteException

setSecondaryNumber

void setSecondaryNumber(String secondaryNumber)
                 throws NXException,
                        RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX8.0.0

Parameters:

secondaryNumber - the drawing sheet secondary number

Throws:

NXException

RemoteException

option

DrawingSheetBuilder.SheetOption option()
                                throws NXException,
                                       RemoteException

Returns the option to be used to create the drawing sheet
License requirements: None.

Created in NX5.0.0

Returns:

the option to be used to create the drawing sheet

Throws:

NXException

RemoteException

setOption

void setOption(DrawingSheetBuilder.SheetOption option)
        throws NXException,
               RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

option - the option to be used to create the drawing sheet

Throws:

NXException

RemoteException

metricSheetTemplateLocation

String metricSheetTemplateLocation()
                            throws NXException,
                                   RemoteException

Returns the location of the metric drawing sheet template to be added to the part file
License requirements: None.

Created in NX5.0.0

Returns:

the drawing sheet template location

Throws:

NXException

RemoteException

setMetricSheetTemplateLocation

void setMetricSheetTemplateLocation(String metricSheetTemplateLocation)
                             throws NXException,
                                    RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

metricSheetTemplateLocation - metric drawing sheet template location

Throws:

NXException

RemoteException

englishSheetTemplateLocation

String englishSheetTemplateLocation()
                             throws NXException,
                                    RemoteException

Returns the location of the english drawing sheet template to be added to the part file
License requirements: None.

Created in NX5.0.0

Returns:

the drawing sheet template location

Throws:

NXException

RemoteException

setEnglishSheetTemplateLocation

void setEnglishSheetTemplateLocation(String englishSheetTemplateLocation)
                              throws NXException,
                                     RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

englishSheetTemplateLocation - english drawing sheet template location

Throws:

NXException

RemoteException

height

double height()
       throws NXException,
              RemoteException

Returns the custom or standard height for the drawing sheet
License requirements: None.

Created in NX5.0.0

Returns:

the custom or standard height for the drawing sheet

Throws:

NXException

RemoteException

setHeight

void setHeight(double height)
        throws NXException,
               RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

height - the custom or standard height for the drawing sheet

Throws:

NXException

RemoteException

length

double length()
       throws NXException,
              RemoteException

Returns the custom or standard length to be used for the drawing to be created or edited.
License requirements: None.

Created in NX5.0.0

Returns:

custom or standard length for the drawing sheet

Throws:

NXException

RemoteException

setLength

void setLength(double length)
        throws NXException,
               RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

length - the custom or standard length for the drawing sheet

Throws:

NXException

RemoteException

standardMetricScale

DrawingSheetBuilder.SheetStandardMetricScale standardMetricScale()
                                                          throws NXException,
                                                                 RemoteException

Returns the standard Metric drawing scale
License requirements: None.

Created in NX5.0.0

Returns:

the standard Metric drawing scale

Throws:

NXException

RemoteException

setStandardMetricScale

void setStandardMetricScale(DrawingSheetBuilder.SheetStandardMetricScale metricScale)
                     throws NXException,
                            RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

metricScale - the standard Metric drawing scale

Throws:

NXException

RemoteException

standardEnglishScale

DrawingSheetBuilder.SheetStandardEnglishScale standardEnglishScale()
                                                            throws NXException,
                                                                   RemoteException

Returns the standard English drawing scale
License requirements: None.

Created in NX5.0.0

Returns:

the standard English drawing scale

Throws:

NXException

RemoteException

setStandardEnglishScale

void setStandardEnglishScale(DrawingSheetBuilder.SheetStandardEnglishScale englishScale)
                      throws NXException,
                             RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

englishScale - the standard English drawing scale

Throws:

NXException

RemoteException

scaleNumerator

double scaleNumerator()
               throws NXException,
                      RemoteException

Returns the numerator of a custom scale
License requirements: None.

Created in NX5.0.0

Returns:

the numerator of a custom scale

Throws:

NXException

RemoteException

setScaleNumerator

void setScaleNumerator(double scaleNumerator)
                throws NXException,
                       RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

scaleNumerator -

Throws:

NXException

RemoteException

scaleDenominator

double scaleDenominator()
                 throws NXException,
                        RemoteException

Returns the denominator of a custom scale
License requirements: None.

Created in NX5.0.0

Returns:

the denominator of a custom scale

Throws:

NXException

RemoteException

setScaleDenominator

void setScaleDenominator(double scaleDenominator)
                  throws NXException,
                         RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

scaleDenominator - the denominator of a custom scale

Throws:

NXException

RemoteException

units

DrawingSheetBuilder.SheetUnits units()
                              throws NXException,
                                     RemoteException

Returns the units for the drawing sheet
License requirements: None.

Created in NX5.0.0

Returns:

the units for the drawing sheet

Throws:

NXException

RemoteException

setUnits

void setUnits(DrawingSheetBuilder.SheetUnits units)
       throws NXException,
              RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

units - the units for the drawing sheet

Throws:

NXException

RemoteException

projectionAngle

DrawingSheetBuilder.SheetProjectionAngle projectionAngle()
                                                  throws NXException,
                                                         RemoteException

Returns the projection_angle option
License requirements: None.

Created in NX5.0.0

Returns:

the projection_angle option

Throws:

NXException

RemoteException

setProjectionAngle

void setProjectionAngle(DrawingSheetBuilder.SheetProjectionAngle projectionAngle)
                 throws NXException,
                        RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX5.0.0

Parameters:

projectionAngle - the projection_angle option

Throws:

NXException

RemoteException

autoStartBaseView

boolean autoStartBaseView()
                   throws NXException,
                          RemoteException

Deprecated. Deprecated in NX7.5.0. Use autoStartViewCreation() instead.

Returns the setting that controls whether or not the Add Base View command is automatically started after inserting a sheet that has no views on it. This option does not appear for Edit Sheet. the toggle is changed to be auto start view creation in Nx7.0, obsolete.
License requirements: None.

Created in NX5.0.0

Returns:

the add base view automatic start toggle

Throws:

NXException

RemoteException

setAutoStartBaseView

void setAutoStartBaseView(boolean autoStartBaseView)
                   throws NXException,
                          RemoteException

Deprecated. Deprecated in NX7.5.0. Use setAutoStartViewCreation(boolean) instead.

License requirements: None.

Created in NX5.0.0

Parameters:

autoStartBaseView - the add base view automatic start toggle

Throws:

NXException

RemoteException

autoStartViewCreation

boolean autoStartViewCreation()
                       throws NXException,
                              RemoteException

Returns the setting that controls whether or not the Add View creation is automatically started after inserting a sheet that has no views on it. This option does not appear for Edit Sheet.
License requirements: None.

Created in NX7.5.0

Returns:

the automatically start view creation

Throws:

NXException

RemoteException

setAutoStartViewCreation

void setAutoStartViewCreation(boolean autoStartViewCreation)
                       throws NXException,
                              RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

autoStartViewCreation - the automatically start view creation

Throws:

NXException

RemoteException

baseordrawingView

DrawingSheetBuilder.SheetBaseordrawingView baseordrawingView()
                                                      throws NXException,
                                                             RemoteException

Returns the option of base view or drawing view
License requirements: None.

Created in NX7.5.0

Returns:

the type of view to automatically start creating

Throws:

NXException

RemoteException

setBaseordrawingView

void setBaseordrawingView(DrawingSheetBuilder.SheetBaseordrawingView option)
                   throws NXException,
                          RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX7.5.0

Parameters:

option - the type of view to automatically start creating

Throws:

NXException

RemoteException

revision

String revision()
         throws NXException,
                RemoteException

Returns the revision of the drawing sheet to be created or edited
License requirements: None.

Created in NX8.0.0

Returns:

the drawing sheet revision

Throws:

NXException

RemoteException

setRevision

void setRevision(String revision)
          throws NXException,
                 RemoteException

License requirements: drafting ("DRAFTING")
.
Created in NX8.0.0

Parameters:

revision - the drawing sheet revision

Throws:

NXException

RemoteException