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

Represents a CannedAnnotationBuilder. More...

Inheritance diagram for NXOpen.Diagramming.CannedAnnotationBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  InheritOption { Preferences, CustomerDefaults, Selection }
 Represents the inherit option. More...
 

Public Member Functions

unsafe
NXOpen.Diagramming.LeaderLineBuilder 
CreateLeaderLine ()
 Create a new NXOpen.Diagramming.LeaderLineBuilder builder. More...
 
unsafe void Inherit (NXOpen.Diagramming.CannedAnnotationBuilder.InheritOption inheritOption, NXOpen.Diagramming.Annotation annotation)
 Inherit. 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
NXOpen.Diagramming.AnnotationBuilder 
AnnotationBuilder [get]
 Returns the annotation of this canned annotation. More...
 
unsafe
NXOpen.Diagramming.LeaderLineBuilderList 
LeaderLines [get]
 Returns the list of the leader lines. More...
 
unsafe int TextBoxIndent [get, set]
 Returns or sets the indent value of the text box in the canned annotation. More...
 
unsafe bool TextBoxModifiable [get, set]
 Returns or sets the flag that indicates if the text box in the canned annotation is modifiable. More...
 
unsafe bool TextBoxShadowBox [get, set]
 Returns or sets the flag that indicates if the text box in the canned annotation has shadow box. 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 a CannedAnnotationBuilder.

To create a new instance of this class, use NXOpen.Diagramming.DiagrammingManager.CreateCannedAnnotationBuilder

Created in NX10.0.0

Member Enumeration Documentation

Represents the inherit option.

Enumerator
Preferences 

Setting the inherit from preferences option

CustomerDefaults 

Setting the inherit from customer defaults option

Selection 

Setting the inherit from selection option

Member Function Documentation

unsafe NXOpen.Diagramming.LeaderLineBuilder NXOpen.Diagramming.CannedAnnotationBuilder.CreateLeaderLine ( )
inline

Create a new NXOpen.Diagramming.LeaderLineBuilder builder.

Created in NX10.0.0

License requirements: None.

Returns
unsafe void NXOpen.Diagramming.CannedAnnotationBuilder.Inherit ( NXOpen.Diagramming.CannedAnnotationBuilder.InheritOption  inheritOption,
NXOpen.Diagramming.Annotation  annotation 
)
inline

Inherit.

Created in NX11.0.0

License requirements: None.

Parameters
inheritOption
annotation

Property Documentation

unsafe NXOpen.Diagramming.AnnotationBuilder NXOpen.Diagramming.CannedAnnotationBuilder.AnnotationBuilder
get

Returns the annotation of this canned annotation.

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Diagramming.LeaderLineBuilderList NXOpen.Diagramming.CannedAnnotationBuilder.LeaderLines
get

Returns the list of the leader lines.

Created in NX10.0.0

License requirements: None.

unsafe int NXOpen.Diagramming.CannedAnnotationBuilder.TextBoxIndent
getset

Returns or sets the indent value of the text box in the canned annotation.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Diagramming.CannedAnnotationBuilder.TextBoxModifiable
getset

Returns or sets the flag that indicates if the text box in the canned annotation is modifiable.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Diagramming.CannedAnnotationBuilder.TextBoxShadowBox
getset

Returns or sets the flag that indicates if the text box in the canned annotation has shadow box.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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