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

Represents a NXOpen.Drawings.ViewDetailLabelBuilder More...

Inheritance diagram for NXOpen.Drawings.ViewDetailLabelBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  LabelParentDisplayTypes {
  None, Circle, Note, Label,
  Embedded, Boundary, LabelOnBoundary
}
 Label on Parent Display type More...
 
enum  LabelParentTextPlacement { BeforeOrAfterStub, AboveStub }
 Label on Parent Text Placement type More...
 

Public Member Functions

unsafe string[] GetCustomizedViewLabelText ()
 Returns the customized view label text More...
 
unsafe void SetCustomizedViewLabelText (string[] customizedText)
 Sets the customized view label text 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 CustomizedViewLabel [get, set]
 Returns or sets the customized view label More...
 
unsafe bool IncludeParentheses [get, set]
 Returns or sets the include parentheses More...
 
unsafe double LabelCharacterHeightFactor [get, set]
 Returns or sets the section vw label letter size factor More...
 
unsafe
NXOpen.Drawings.ViewDetailLabelBuilder.LabelParentDisplayTypes 
LabelParentDisplay [get, set]
 Returns or sets the label parent display More...
 
unsafe
NXOpen.Drawings.LabelPositionTypes 
LabelPosition [get, set]
 Returns or sets the label position More...
 
unsafe string LabelPrefix [get, set]
 Returns or sets the label prefix More...
 
unsafe
NXOpen.Drawings.LetterFormatTypes 
LetterFormat [get, set]
 Returns or sets the letter format More...
 
unsafe string ParentLabelPrefix [get, set]
 Returns or sets the parent label prefix More...
 
unsafe double PrefixCharacterHeightFactor [get, set]
 Returns or sets the prefix character height factor More...
 
unsafe
NXOpen.Drawings.ReferenceShowTypes 
ReferenceToShow [get, set]
 Returns or sets the reference to show More...
 
unsafe double ScaleCharacterHeightFactor [get, set]
 Returns or sets the scale character height factor More...
 
unsafe
NXOpen.Drawings.ScalePositionTypes 
ScalePosition [get, set]
 Returns or sets the scale position More...
 
unsafe string ScalePrefix [get, set]
 Returns or sets the scale prefix More...
 
unsafe bool ShowViewLabel [get, set]
 Returns or sets the show view label More...
 
unsafe bool ShowViewScale [get, set]
 Returns or sets the show view scale More...
 
unsafe double TextGapFactor [get, set]
 Returns or sets the text gap factor More...
 
unsafe
NXOpen.Drawings.ViewDetailLabelBuilder.LabelParentTextPlacement 
TextPlacement [get, set]
 Returns or sets the text placement More...
 
unsafe
NXOpen.Drawings.ScaleValueFormatTypes 
ValueFormat [get, set]
 Returns or sets the value format More...
 
unsafe
NXOpen.Drawings.ViewLabelTypes 
ViewLabelOption [get, set]
 Returns or sets the view label option 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.Drawings.ViewDetailLabelBuilder

Created in NX9.0.0

Member Enumeration Documentation

Label on Parent Display type

Enumerator
None 
Circle 
Note 
Label 
Embedded 
Boundary 
LabelOnBoundary 

Label on Parent Text Placement type

Enumerator
BeforeOrAfterStub 
AboveStub 

Member Function Documentation

unsafe string [] NXOpen.Drawings.ViewDetailLabelBuilder.GetCustomizedViewLabelText ( )
inline

Returns the customized view label text

Created in NX10.0.0

License requirements: drafting ("DRAFTING")

Returns
unsafe void NXOpen.Drawings.ViewDetailLabelBuilder.SetCustomizedViewLabelText ( string[]  customizedText)
inline

Sets the customized view label text

Created in NX10.0.0

License requirements: drafting ("DRAFTING")

Parameters
customizedText
unsafe bool NXOpen.Drawings.ViewDetailLabelBuilder.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.Drawings.ViewDetailLabelBuilder.CustomizedViewLabel
getset

Returns or sets the customized view label

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Drawings.ViewDetailLabelBuilder.IncludeParentheses
getset

Returns or sets the include parentheses

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe double NXOpen.Drawings.ViewDetailLabelBuilder.LabelCharacterHeightFactor
getset

Returns or sets the section vw label letter size factor

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Drawings.ViewDetailLabelBuilder.LabelParentDisplayTypes NXOpen.Drawings.ViewDetailLabelBuilder.LabelParentDisplay
getset

Returns or sets the label parent display

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Drawings.LabelPositionTypes NXOpen.Drawings.ViewDetailLabelBuilder.LabelPosition
getset

Returns or sets the label position

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe string NXOpen.Drawings.ViewDetailLabelBuilder.LabelPrefix
getset

Returns or sets the label prefix

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Drawings.LetterFormatTypes NXOpen.Drawings.ViewDetailLabelBuilder.LetterFormat
getset

Returns or sets the letter format

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe string NXOpen.Drawings.ViewDetailLabelBuilder.ParentLabelPrefix
getset

Returns or sets the parent label prefix

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe double NXOpen.Drawings.ViewDetailLabelBuilder.PrefixCharacterHeightFactor
getset

Returns or sets the prefix character height factor

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Drawings.ReferenceShowTypes NXOpen.Drawings.ViewDetailLabelBuilder.ReferenceToShow
getset

Returns or sets the reference to show

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe double NXOpen.Drawings.ViewDetailLabelBuilder.ScaleCharacterHeightFactor
getset

Returns or sets the scale character height factor

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Drawings.ScalePositionTypes NXOpen.Drawings.ViewDetailLabelBuilder.ScalePosition
getset

Returns or sets the scale position

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe string NXOpen.Drawings.ViewDetailLabelBuilder.ScalePrefix
getset

Returns or sets the scale prefix

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Drawings.ViewDetailLabelBuilder.ShowViewLabel
getset

Returns or sets the show view label

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Drawings.ViewDetailLabelBuilder.ShowViewScale
getset

Returns or sets the show view scale

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe double NXOpen.Drawings.ViewDetailLabelBuilder.TextGapFactor
getset

Returns or sets the text gap factor

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Drawings.ViewDetailLabelBuilder.LabelParentTextPlacement NXOpen.Drawings.ViewDetailLabelBuilder.TextPlacement
getset

Returns or sets the text placement

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Drawings.ScaleValueFormatTypes NXOpen.Drawings.ViewDetailLabelBuilder.ValueFormat
getset

Returns or sets the value format

Created in NX9.0.0

License requirements to get this property: None.

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

unsafe NXOpen.Drawings.ViewLabelTypes NXOpen.Drawings.ViewDetailLabelBuilder.ViewLabelOption
getset

Returns or sets the view label option

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.