NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::AME::FormSheetBuilder Class Reference

JA class for the Form Sheet dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateFormSheetBuilder
Default values. More...

Inheritance diagram for NXOpen::AME::FormSheetBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SizeOption { SizeOptionStandard, SizeOptionCustom }
 Represents form sheet size option. More...
 
enum  StandardMetricSize {
  StandardMetricSizeA4landscape, StandardMetricSizeA3landscape, StandardMetricSizeA2landscape, StandardMetricSizeA1landscape,
  StandardMetricSizeA0landscape, StandardMetricSizeA4portrait
}
 Represents standard metric sizes for form sheet. More...
 

Public Member Functions

NXOpen::AME::BasicPropertiesBuilderBasicProperties ()
 Returns the name and description
Created in NX12.0.0. More...
 
NXOpen::AME::FormSheetBuilder::SizeOption FormSheetSizeOption ()
 Returns the size option type of type NXOpen::AME::FormSheetBuilder::SizeOption
Created in NX12.0.0. More...
 
NXOpen::AME::FormSheetBuilder::StandardMetricSize FormSheetStandardMetricSize ()
 Returns the standard metric size of type NXOpen::AME::FormSheetBuilder::StandardMetricSize
Created in NX12.0.0. More...
 
double Height ()
 Returns the height
Created in NX12.0.0. More...
 
double Length ()
 Returns the length
Created in NX12.0.0. More...
 
void SetFormSheetSizeOption (NXOpen::AME::FormSheetBuilder::SizeOption sizeOption)
 Sets the size option type of type NXOpen::AME::FormSheetBuilder::SizeOption
Created in NX12.0.0. More...
 
void SetFormSheetStandardMetricSize (NXOpen::AME::FormSheetBuilder::StandardMetricSize standardMetricSize)
 Sets the standard metric size of type NXOpen::AME::FormSheetBuilder::StandardMetricSize
Created in NX12.0.0. More...
 
void SetHeight (double height)
 Sets the height
Created in NX12.0.0. More...
 
void SetLength (double length)
 Sets the length
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

JA class for the Form Sheet dialog
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateFormSheetBuilder
Default values.

Property Value

FormSheetSizeOption

Standard

FormSheetStandardMetricSize

A3landscape

Height

297

Length

420


Created in NX12.0.0.

Member Enumeration Documentation

Represents form sheet size option.

Enumerator
SizeOptionStandard 

standard

SizeOptionCustom 

custom

Represents standard metric sizes for form sheet.

Enumerator
StandardMetricSizeA4landscape 

a4landscape

StandardMetricSizeA3landscape 

a3landscape

StandardMetricSizeA2landscape 

a2landscape

StandardMetricSizeA1landscape 

a1landscape

StandardMetricSizeA0landscape 

a0landscape

StandardMetricSizeA4portrait 

a4portrait

Member Function Documentation

NXOpen::AME::BasicPropertiesBuilder* NXOpen::AME::FormSheetBuilder::BasicProperties ( )

Returns the name and description
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::FormSheetBuilder::SizeOption NXOpen::AME::FormSheetBuilder::FormSheetSizeOption ( )

Returns the size option type of type NXOpen::AME::FormSheetBuilder::SizeOption
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::FormSheetBuilder::StandardMetricSize NXOpen::AME::FormSheetBuilder::FormSheetStandardMetricSize ( )

Returns the standard metric size of type NXOpen::AME::FormSheetBuilder::StandardMetricSize
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

double NXOpen::AME::FormSheetBuilder::Height ( )

Returns the height
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

double NXOpen::AME::FormSheetBuilder::Length ( )

Returns the length
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::FormSheetBuilder::SetFormSheetSizeOption ( NXOpen::AME::FormSheetBuilder::SizeOption  sizeOption)

Sets the size option type of type NXOpen::AME::FormSheetBuilder::SizeOption
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
sizeOptionsizeoption
void NXOpen::AME::FormSheetBuilder::SetFormSheetStandardMetricSize ( NXOpen::AME::FormSheetBuilder::StandardMetricSize  standardMetricSize)

Sets the standard metric size of type NXOpen::AME::FormSheetBuilder::StandardMetricSize
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
standardMetricSizestandardmetricsize
void NXOpen::AME::FormSheetBuilder::SetHeight ( double  height)

Sets the height
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
heightheight
void NXOpen::AME::FormSheetBuilder::SetLength ( double  length)

Sets the length
Created in NX12.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
lengthlength

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