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

Represents a NXOpen.Annotations.PartsListBuilder . More...

Inheritance diagram for NXOpen.Annotations.PartsListBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  PartsListGrowDirectionOptions { Up, Down }
 Grow direction options The options specify the direction of growth for the parts list More...
 
enum  PartsListMainSymbolText {
  None, Callout, PartName, CalloutandQuantity,
  Custom
}
 Main Symbol Text Types Specifies the text to display in the main callout symbol More...
 
enum  PartsListReferenceSymbolText {
  None, Callout, PartName, CalloutandQuantity,
  Custom
}
 Reference Symbol Text Types Specifies the text to display in the reference callout symbol More...
 
enum  PartsListShowLockedDeletedRows { Strikethrough, Blanked, Hidden, Ordinary }
 Locked deleted rows options The options specify how to show rows that are locked, but reference components that have been removed from the assembly More...
 
enum  PartsListSymbolType {
  None, Circle, DividedCircle, TrianglePointedDown,
  TrianglePointedUp, Square, DividedSquare, Hexagon,
  DividedHexagon, QuadrantCircle, RoundedBox, Underline,
  Label
}
 Symbol Types The types specify the balloon type used to call out members More...
 
enum  PartsListVerticalGroupLeaderAttachment { Top, Bottom }
 Represents leader attachment for vertical callout groups. More...
 

Public Member Functions

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 AllowManualRows [get, set]
 Returns or sets the allow manual rows option that determines whether or not manual rows are allowed to be inserted into a parts list More...
 
unsafe bool AutomaticUpdate [get, set]
 Returns or sets the automatic update option to determine whether or not the parts list updates automatically whenever a change occurs to a referenced object in the model More...
 
unsafe string CalloutSuffix [get, set]
 Returns or sets the callout suffix specifies the suffix to be used for reference symbol text More...
 
unsafe string CharToSkip [get, set]
 Returns or sets the characters to skip specifies the characters to be skipped for callouts More...
 
unsafe bool CreateNewRowAsLocked [get, set]
 Returns or sets the create new row as locked option that determines whether new rows in the parts list are locked automatically on creation More...
 
unsafe bool EnableCrossHighlighting [get, set]
 Returns or sets the flag to enable cross highlighting More...
 
unsafe
NXOpen.Annotations.PartsListBuilder.PartsListGrowDirectionOptions 
GrowDirectionOptions [get, set]
 Returns or sets the grow direction options that specify the direction of growth for the parts list More...
 
unsafe NXOpen.NXColor HighlightColor [get, set]
 Returns or sets the highlight color specifies the color used for the delimiters that highlight manual cell text More...
 
unsafe bool HighlightManualText [get, set]
 Returns or sets the highlight manual text specifies whether manual cell text is to be highlighted by delimiters More...
 
unsafe int Increment [get, set]
 Returns or sets the increment specifies the value by which consecutive callout values are be incremented More...
 
unsafe string InitialCallout [get, set]
 Returns or sets the initial callout specifies the text string used to represent the first callout in the parts list More...
 
unsafe bool LockPartsListSetup [get, set]
 Returns or sets the Lock Parts List Setup option that determines Is the parts list setup protected/locked More...
 
unsafe string MainSymbolCustomText [get, set]
 Returns or sets the main symbol custom text specifies the custom text to display in the main callout symbol More...
 
unsafe
NXOpen.Annotations.PartsListBuilder.PartsListMainSymbolText 
MainSymbolText [get, set]
 Returns or sets the main symbol text specifies the text to display in the main callout symbol More...
 
unsafe string ReferenceSymbolCustomText [get, set]
 Returns or sets the reference symbol custom text specifies the custom text to display in the main callout symbol More...
 
unsafe
NXOpen.Annotations.PartsListBuilder.PartsListReferenceSymbolText 
ReferenceSymbolText [get, set]
 Returns or sets the reference symbol text specifies the text to display in the reference callout symbol More...
 
unsafe
NXOpen.Annotations.PartsListBuilder.PartsListShowLockedDeletedRows 
ShowLockedDeletedRows [get, set]
 Returns or sets the show locked deleted rows option to show rows that are locked, but reference components that have been removed from the assembly More...
 
unsafe bool ShowReferenceCalloutSuffix [get, set]
 Returns or sets the flag indicating whether the reference callout suffix will be displayed. More...
 
unsafe bool SortOnUpdate [get, set]
 Returns or sets the sort on update option that determines whether or not the parts list sorts automatically during update More...
 
unsafe
NXOpen.Annotations.PartsListBuilder.PartsListSymbolType 
Symbol [get, set]
 Returns or sets the symbol type specifies the balloon type used to call out members More...
 
unsafe
NXOpen.Annotations.PartsListBuilder.PartsListVerticalGroupLeaderAttachment 
VerticalGroupAttachment [get, set]
 Returns or sets the leader attachment to vertical callout groups 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.Annotations.PartsListBuilder .

This class queries and sets settings specific to parts list when creating or editing parts list settings.

This is a sub-builder class and cannot be directly instantiated

Created in NX9.0.0

Member Enumeration Documentation

Grow direction options The options specify the direction of growth for the parts list

Enumerator
Up 
Down 

Main Symbol Text Types Specifies the text to display in the main callout symbol

Enumerator
None 
Callout 
PartName 
CalloutandQuantity 
Custom 

Reference Symbol Text Types Specifies the text to display in the reference callout symbol

Enumerator
None 
Callout 
PartName 
CalloutandQuantity 
Custom 

Locked deleted rows options The options specify how to show rows that are locked, but reference components that have been removed from the assembly

Enumerator
Strikethrough 
Blanked 
Hidden 
Ordinary 

Symbol Types The types specify the balloon type used to call out members

Enumerator
None 
Circle 
DividedCircle 
TrianglePointedDown 
TrianglePointedUp 
Square 
DividedSquare 
Hexagon 
DividedHexagon 
QuadrantCircle 
RoundedBox 
Underline 
Label 

Represents leader attachment for vertical callout groups.

Enumerator
Top 
Bottom 

Member Function Documentation

unsafe bool NXOpen.Annotations.PartsListBuilder.Validate ( )
inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe bool NXOpen.Annotations.PartsListBuilder.AllowManualRows
getset

Returns or sets the allow manual rows option that determines whether or not manual rows are allowed to be inserted into a parts list

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Annotations.PartsListBuilder.AutomaticUpdate
getset

Returns or sets the automatic update option to determine whether or not the parts list updates automatically whenever a change occurs to a referenced object in the model

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Annotations.PartsListBuilder.CalloutSuffix
getset

Returns or sets the callout suffix specifies the suffix to be used for reference symbol text

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Annotations.PartsListBuilder.CharToSkip
getset

Returns or sets the characters to skip specifies the characters to be skipped for callouts

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Annotations.PartsListBuilder.CreateNewRowAsLocked
getset

Returns or sets the create new row as locked option that determines whether new rows in the parts list are locked automatically on creation

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Annotations.PartsListBuilder.EnableCrossHighlighting
getset

Returns or sets the flag to enable cross highlighting

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Annotations.PartsListBuilder.PartsListGrowDirectionOptions NXOpen.Annotations.PartsListBuilder.GrowDirectionOptions
getset

Returns or sets the grow direction options that specify the direction of growth for the parts list

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.NXColor NXOpen.Annotations.PartsListBuilder.HighlightColor
getset

Returns or sets the highlight color specifies the color used for the delimiters that highlight manual cell text

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Annotations.PartsListBuilder.HighlightManualText
getset

Returns or sets the highlight manual text specifies whether manual cell text is to be highlighted by delimiters

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Annotations.PartsListBuilder.Increment
getset

Returns or sets the increment specifies the value by which consecutive callout values are be incremented

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Annotations.PartsListBuilder.InitialCallout
getset

Returns or sets the initial callout specifies the text string used to represent the first callout in the parts list

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Annotations.PartsListBuilder.LockPartsListSetup
getset

Returns or sets the Lock Parts List Setup option that determines Is the parts list setup protected/locked

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Annotations.PartsListBuilder.MainSymbolCustomText
getset

Returns or sets the main symbol custom text specifies the custom text to display in the main callout symbol

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Annotations.PartsListBuilder.PartsListMainSymbolText NXOpen.Annotations.PartsListBuilder.MainSymbolText
getset

Returns or sets the main symbol text specifies the text to display in the main callout symbol

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Annotations.PartsListBuilder.ReferenceSymbolCustomText
getset

Returns or sets the reference symbol custom text specifies the custom text to display in the main callout symbol

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Annotations.PartsListBuilder.PartsListReferenceSymbolText NXOpen.Annotations.PartsListBuilder.ReferenceSymbolText
getset

Returns or sets the reference symbol text specifies the text to display in the reference callout symbol

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Annotations.PartsListBuilder.PartsListShowLockedDeletedRows NXOpen.Annotations.PartsListBuilder.ShowLockedDeletedRows
getset

Returns or sets the show locked deleted rows option to show rows that are locked, but reference components that have been removed from the assembly

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Annotations.PartsListBuilder.ShowReferenceCalloutSuffix
getset

Returns or sets the flag indicating whether the reference callout suffix will be displayed.

A value of true indicates that the suffix will be displayed.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Annotations.PartsListBuilder.SortOnUpdate
getset

Returns or sets the sort on update option that determines whether or not the parts list sorts automatically during update

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Annotations.PartsListBuilder.PartsListSymbolType NXOpen.Annotations.PartsListBuilder.Symbol
getset

Returns or sets the symbol type specifies the balloon type used to call out members

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Annotations.PartsListBuilder.PartsListVerticalGroupLeaderAttachment NXOpen.Annotations.PartsListBuilder.VerticalGroupAttachment
getset

Returns or sets the leader attachment to vertical callout groups

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING")


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