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

Represents a String block More...

Inheritance diagram for NXOpen.BlockStyler.StringBlock:
NXOpen.BlockStyler.UIBlock NXOpen.TaggedObject NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

class  _StringBlockKeystrokeCallbackAdapter
 

Public Member Functions

unsafe string[] GetBalloonTooltipImages ()
 Gets the BalloonTooltipImages More...
 
unsafe string[] GetBalloonTooltipLayoutMembers ()
 Gets the BalloonTooltipLayout members More...
 
unsafe string[] GetBalloonTooltipTexts ()
 Gets the BalloonTooltipTexts More...
 
unsafe string[] GetListItems ()
 Gets the ListItems More...
 
unsafe string[] GetPresentationStyleMembers ()
 Gets the PresentationStyle members More...
 
unsafe string[] GetWidthMembers ()
 Gets the Width members More...
 
delegate int KeystrokeCallback (NXOpen.BlockStyler.StringBlock stringBlock, string uncommittedValue)
 The keystroke callback that is registered by calling SetKeystrokeCallback . More...
 
unsafe void SetBalloonTooltipImages (string[] imageStrings)
 Sets the BalloonTooltipImages More...
 
unsafe void SetBalloonTooltipTexts (string[] tooltipTextArray)
 Sets the BalloonTooltipTexts More...
 
unsafe void SetKeystrokeCallback (NXOpen.BlockStyler.StringBlock.KeystrokeCallback cb)
 Sets the keystroke callback for Block Styler String Block. More...
 
unsafe void SetListItems (string[] itemStrings)
 Sets the ListItems More...
 
- Public Member Functions inherited from NXOpen.BlockStyler.UIBlock
unsafe void Focus ()
 Focuses on the block. More...
 
unsafe
NXOpen.BlockStyler.PropertyList 
GetProperties ()
 Returns the properties of the block 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 AllowInternationalTextInput [get, set]
 Returns or sets the AllowInternationalTextInput More...
 
unsafe string BalloonTooltipLayoutAsString [get, set]
 Returns or sets the BalloonTooltipLayout as string More...
 
unsafe string Bitmap [get, set]
 Returns or sets the Bitmap More...
 
unsafe bool IsPassword [get, set]
 Returns or sets the IsPassword. More...
 
unsafe bool Localize [get, set]
 Returns or sets the Localize More...
 
unsafe int MaxTextLength [get, set]
 Returns or sets the MaxTextLength More...
 
unsafe string PresentationStyleAsString [get, set]
 Returns or sets the PresentationStyle as string More...
 
unsafe bool ReadOnlyString [get, set]
 Returns or sets the ReadOnlyString More...
 
unsafe bool RetainValue [get, set]
 Returns or sets the RetainValue More...
 
unsafe string Tooltip [get, set]
 Returns or sets the Tooltip More...
 
unsafe string Value [get, set]
 Returns or sets the Value More...
 
unsafe string WideValue [get, set]
 Returns or sets the WideValue. More...
 
unsafe string WidthAsString [get, set]
 Returns or sets the Width as string More...
 
- Properties inherited from NXOpen.BlockStyler.UIBlock
unsafe bool Enable [get, set]
 Returns or sets the Enable. More...
 
unsafe bool Expanded [get, set]
 Returns or sets the Expanded More...
 
unsafe bool Group [get, set]
 Returns or sets the Group More...
 
unsafe string Label [get, set]
 Returns or sets the Label More...
 
unsafe string Name [get]
 Returns the name of the block or BlockID More...
 
unsafe bool Show [get, set]
 Returns or sets the Visibility of block. More...
 
unsafe string Type [get]
 Returns the type of block 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 String block

Created in NX8.5.0

Member Function Documentation

unsafe string [] NXOpen.BlockStyler.StringBlock.GetBalloonTooltipImages ( )
inline

Gets the BalloonTooltipImages

Created in NX8.5.0

License requirements: None.

Returns
unsafe string [] NXOpen.BlockStyler.StringBlock.GetBalloonTooltipLayoutMembers ( )
inline

Gets the BalloonTooltipLayout members

Created in NX8.5.0

License requirements: None.

Returns
Values to get from the property
unsafe string [] NXOpen.BlockStyler.StringBlock.GetBalloonTooltipTexts ( )
inline

Gets the BalloonTooltipTexts

Created in NX8.5.0

License requirements: None.

Returns
Values to get from the property.
unsafe string [] NXOpen.BlockStyler.StringBlock.GetListItems ( )
inline

Gets the ListItems

Created in NX8.5.0

License requirements: None.

Returns
Values to get from the property
unsafe string [] NXOpen.BlockStyler.StringBlock.GetPresentationStyleMembers ( )
inline

Gets the PresentationStyle members

Created in NX8.5.0

License requirements: None.

Returns
Values to get from the property.
unsafe string [] NXOpen.BlockStyler.StringBlock.GetWidthMembers ( )
inline

Gets the Width members

Created in NX8.5.0

License requirements: None.

Returns
Values to get from the property.
delegate int NXOpen.BlockStyler.StringBlock.KeystrokeCallback ( NXOpen.BlockStyler.StringBlock  stringBlock,
string  uncommittedValue 
)

The keystroke callback that is registered by calling SetKeystrokeCallback .

It will get called for each key stroke the user makes in the String Block input field.

Created in NX12.0.1

License requirements: None.

Parameters
stringBlockString Block object for which keystroke event is invoked
uncommittedValueThe text being typed in the string block at runtime
unsafe void NXOpen.BlockStyler.StringBlock.SetBalloonTooltipImages ( string[]  imageStrings)
inline

Sets the BalloonTooltipImages

Created in NX8.5.0

License requirements: None.

Parameters
imageStrings
unsafe void NXOpen.BlockStyler.StringBlock.SetBalloonTooltipTexts ( string[]  tooltipTextArray)
inline

Sets the BalloonTooltipTexts

Created in NX8.5.0

License requirements: None.

Parameters
tooltipTextArrayValue to set for the property.
unsafe void NXOpen.BlockStyler.StringBlock.SetKeystrokeCallback ( NXOpen.BlockStyler.StringBlock.KeystrokeCallback  cb)
inline

Sets the keystroke callback for Block Styler String Block.

Created in NX12.0.1

License requirements: None.

Parameters
cbCallback function for keystroke event.
unsafe void NXOpen.BlockStyler.StringBlock.SetListItems ( string[]  itemStrings)
inline

Sets the ListItems

Created in NX8.5.0

License requirements: None.

Parameters
itemStringsValue to set to the property

Property Documentation

unsafe bool NXOpen.BlockStyler.StringBlock.AllowInternationalTextInput
getset

Returns or sets the AllowInternationalTextInput

Created in NX8.5.0

Deprecated in NX12.0.0. Not required from NX10 onwards. Internationalization is available by default.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.StringBlock.BalloonTooltipLayoutAsString
getset

Returns or sets the BalloonTooltipLayout as string

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.StringBlock.Bitmap
getset

Returns or sets the Bitmap

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.StringBlock.IsPassword
getset

Returns or sets the IsPassword.

If true, characters will not be readable. They will be displayed as *.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.StringBlock.Localize
getset

Returns or sets the Localize

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.StringBlock.MaxTextLength
getset

Returns or sets the MaxTextLength

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.StringBlock.PresentationStyleAsString
getset

Returns or sets the PresentationStyle as string

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.StringBlock.ReadOnlyString
getset

Returns or sets the ReadOnlyString

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.StringBlock.RetainValue
getset

Returns or sets the RetainValue

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.StringBlock.Tooltip
getset

Returns or sets the Tooltip

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.StringBlock.Value
getset

Returns or sets the Value

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.StringBlock.WideValue
getset

Returns or sets the WideValue.

Specifies the International text. This property accepts international characters supported by NX.

Created in NX8.5.0

Deprecated in NX12.0.0. Use 'Value' instead which supports Internationalization.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.StringBlock.WidthAsString
getset

Returns or sets the Width as string

Created in NX8.5.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.