• Articles
  • API reference
  • Previous Versions
Show / Hide Table of Contents
  • Connector
    • Vortex.Adapters.Connector.Tc3
      • AdsConnector
      • AdsConnector.OnAdsStateChangeDelegate
      • LiveClient
      • OnlineSymbolRetriever
      • OnlineVariableInfo
      • OnlineVariableInfo.SymbolLoaderSettings
      • ReportingConsole
      • ReportingConsole.UpdateStartUpDelegate
    • Vortex.Adapters.Connector.Tc3.Adapter
      • ConnectorFactory
      • SymbolLoadingMode
      • SymbolLoadMethod
      • Tc3ConnectorAdapter
    • Vortex.Adapters.Connector.Tc3.AdsExceptionsHandling
      • ExceptionHandler
    • Vortex.Adapters.Connector.Tc3.AdsValueTypes
      • AdsBit
      • AdsBool
      • AdsByte
      • AdsDate
      • AdsDateTime
      • AdsDInt
      • AdsDWord
      • AdsInt
      • AdsLInt
      • AdsLReal
      • AdsLTime
      • AdsLWord
      • AdsReal
      • AdsSInt
      • AdsString
      • AdsTime
      • AdsTimeOfDay
      • AdsUDInt
      • AdsUInt
      • AdsULInt
      • AdsUSInt
      • AdsWord
      • AdsWString
      • ClientSymbol
      • IAdsBaseType
    • Vortex.Adapters.Connector.Tc3Adapter.Adapter
      • NamespaceDoc
    • Vortex.Connector
      • CommStateEnum
      • ConnectorAdapter
      • DataExchangeStatusEnum
      • DummyConnector
      • DummyConnectorFactory
      • EnumeratorDiscriminatorAttribute
      • IConnector
      • IConnectorFactory
      • IgnoreReflectionAttribute
      • InterpolatedAncestor
      • InvalidLicenseConnector
      • InvalidLicenseConnectorAdapter
      • InvalidLicenseConnectorFactory
      • IPlain
      • ITwinController
      • ITwinObject
      • ITwinPrimitive
      • IValueTag
      • IValueTagExtensions
      • IValueTagInfo
      • IVortexElement
      • IVortexObject
      • IVortexObjectExtensions
      • IVortexOnlineObject
      • IVortexShadowObject
      • NamespaceDoc
      • RootVortexerObject
      • StringInterpolator
      • TypeComplexityEnum
    • Vortex.Connector.Attributes
      • AssemblyPlcCounterPart
      • CompilerOmissionGroups
      • CompilerOmitsAttribute
      • ReadOnlyAttribute
      • TypeMetaDescriptorAttribute
    • Vortex.Connector.Identity
      • IVortexIdentity
      • MemberByIdentityAttribute
      • NullVortexIdentity
      • VortexIdentityProvider
    • Vortex.Connector.LibraryDescriptors
      • TypeMetaData
    • Vortex.Connector.ValueTypes
      • NamespaceDoc
      • OnlinerBaseType
      • OnlinerBaseType.ValueChangeDelegate
      • OnlinerBaseType<T>
      • OnlinerBit
      • OnlinerBool
      • OnlinerByte
      • OnlinerDate
      • OnlinerDateTime
      • OnlinerDInt
      • OnlinerDWord
      • OnlinerInt
      • OnlinerLInt
      • OnlinerLReal
      • OnlinerLTime
      • OnlinerLWord
      • OnlinerReal
      • OnlinerSInt
      • OnlinerString
      • OnlinerTime
      • OnlinerTimeOfDay
      • OnlinerUDInt
      • OnlinerUInt
      • OnlinerULInt
      • OnlinerUSInt
      • OnlinerWord
      • OnlinerWString
      • ReadWriteAccess
      • ValueChangedEventArgs
      • ValueChangedEventHandlerDelegate
    • Vortex.Connector.ValueTypes.Online
      • IOnline<T>
      • IOnlineBit
      • IOnlineBool
      • IOnlineByte
      • IOnlineDate
      • IOnlineDateTime
      • IOnlineDInt
      • IOnlineDWord
      • IOnlineInt
      • IOnlineLInt
      • IOnlineLReal
      • IOnlineLTime
      • IOnlineLWord
      • IOnlineReal
      • IOnlineSInt
      • IOnlineString
      • IOnlineTime
      • IOnlineTimeOfDay
      • IOnlineUDInt
      • IOnlineUInt
      • IOnlineULInt
      • IOnlineUSInt
      • IOnlineWord
      • IOnlineWString
      • NamespaceDoc
    • Vortex.Connector.ValueTypes.Shadows
      • IShadow<T>
      • IShadowBit
      • IShadowBool
      • IShadowByte
      • IShadowDate
      • IShadowDateTime
      • IShadowDInt
      • IShadowDWord
      • IShadowInt
      • IShadowLInt
      • IShadowLReal
      • IShadowLTime
      • IShadowLWord
      • IShadowReal
      • IShadowSInt
      • IShadowString
      • IShadowTime
      • IShadowTimeOfDay
      • IShadowUDInt
      • IShadowUInt
      • IShadowULInt
      • IShadowUSInt
      • IShadowWord
      • IShadowWString
      • NamespaceDoc
    • Vortex.Connector.ValueValidation
      • BitValueValidationRule
      • BoolValueValidationRule
      • ByteValueValidationRule
      • DateTimeValueValidationRule
      • DateValueValidationRule
      • DintValueValidationRule
      • DWordValueValidationRule
      • IntValueValidationRule
      • IValueBoundaries<T>
      • LIntValueValidationRule
      • LRealValueValidationRule
      • LTimeValueValidationRule
      • LWordValueValidationRule
      • NamespaceDoc
      • OnlinerValidationRule<T>
      • RealValueValidationRule
      • SIntValueValidationRule
      • StringValueValidationRule
      • TimeOfDayValueValidationRule
      • TimeValueValidationRule
      • UDIntValueValidationRule
      • UIntValueValidationRule
      • ULIntValueValidationRule
      • USintValueValidationRule
      • ValidationResult
      • WordValueValidationRule
      • WStringValueValidationRule
    • Vortex.Localizations
      • IdentifierValidator
      • LocalizableItem
      • Localizables
      • LocalizationHelper
      • LocalizerDictionary
  • Presentation
    • Vortex.Presentation.Controls.Wpf
      • DateTimePickerBox
      • MultiConverter
      • TimePickerBaseBox
      • TimeTextBoxBaseBox
    • Vortex.Presentation.Controls.Wpf.Enumerators
      • EnumeratorContainer
      • EnumeratorContainerControlSlimView
      • EnumeratorContainerControlSlimViewModel
      • EnumeratorContainerControlView
      • EnumeratorContainerControlViewModel
      • EnumeratorContainerDisplaySlimView
      • EnumeratorContainerDisplaySlimViewModel
      • EnumeratorContainerDisplayView
      • EnumeratorContainerDisplayViewModel
      • EnumeratorContainerShadowControlSlimView
      • EnumeratorContainerShadowControlSlimViewModel
      • EnumeratorContainerShadowControlView
      • EnumeratorContainerShadowControlViewModel
      • EnumeratorContainerShadowDisplaySlimView
      • EnumeratorContainerShadowDisplaySlimViewModel
      • EnumeratorContainerShadowDisplayView
      • EnumeratorContainerShadowDisplayViewModel
      • EnumeratorContainerViewModel
      • EnumToIntConverter
    • Vortex.Presentation.Controls.Wpf.Extension
      • AttributeStringFormatExtensions
      • DateTimePicker
    • Vortex.Presentation.Controls.Wpf.OnlineControl
      • OnlineControlCheckBox
      • OnlineControlCheckBoxValue
      • OnlineControlDate
      • OnlineControlDateTime
      • OnlineControlLTime
      • OnlineControlTextBox
      • OnlineControlTextBoxValue
      • OnlineControlTime
      • OnlineControlTimeOfDay
      • OnlineControlTimeTextBox
    • Vortex.Presentation.Controls.Wpf.OnlineControls
      • OnlineControlSlimCheckBox
      • OnlineControlSlimCheckBoxValue
      • OnlineControlSlimDate
      • OnlineControlSlimDateTime
      • OnlineControlSlimLTime
      • OnlineControlSlimTextBox
      • OnlineControlSlimTextBoxValue
      • OnlineControlSlimTime
      • OnlineControlSlimTimeOfDay
    • Vortex.Presentation.Controls.Wpf.OnlineDisplay
      • OnlineDisplayCheckBox
      • OnlineDisplayTextBox
      • OnlineDisplayTextBoxValue
      • OnlineDisplayTimeTextBox
    • Vortex.Presentation.Controls.Wpf.ShadowControl
      • ShadowControlCheckBox
      • ShadowControlCheckBoxValue
      • ShadowControlDate
      • ShadowControlDateTime
      • ShadowControlLTime
      • ShadowControlTextBox
      • ShadowControlTextBoxValue
      • ShadowControlTime
      • ShadowControlTimeOfDay
      • ShadowControlTimeTextBox
    • Vortex.Presentation.Controls.Wpf.ShadowDisplay
      • ShadowDisplayCheckBox
      • ShadowDisplayTextBox
      • ShadowDisplayTextBoxValue
      • ShadowDisplayTimeTextBox
    • Vortex.Presentation.Controls.Wpf.Shared.Base
      • TimeAndDateConverterFactory
    • Vortex.Presentation.ControlSlims.Wpf
      • MultiConverter
    • Vortex.Presentation.ControlSlims.Wpf.OnlineDisplaySlim
      • OnlineDisplaySlimCheckBox
      • OnlineDisplaySlimTextBox
      • OnlineDisplaySlimTextBoxValue
      • OnlineDisplaySlimTimeTextBox
    • Vortex.Presentation.ControlSlims.Wpf.ShadowControlSlim
      • ShadowControlSlimCheckBox
      • ShadowControlSlimCheckBoxValue
      • ShadowControlSlimDate
      • ShadowControlSlimDateTime
      • ShadowControlSlimLTime
      • ShadowControlSlimTextBox
      • ShadowControlSlimTextBoxValue
      • ShadowControlSlimTime
      • ShadowControlSlimTimeOfDay
    • Vortex.Presentation.ControlSlims.Wpf.ShadowDisplaySlim
      • ShadowDisplaySlimCheckBox
      • ShadowDisplaySlimTextBox
      • ShadowDisplaySlimTextBoxValue
      • ShadowDisplaySlimTimeTextBox
    • Vortex.Presentation.Styling.Wpf
      • VortexResources
    • Vortex.Presentation.Styling.Wpf.Assist
      • DataGridAssist
    • Vortex.Presentation.Wpf
      • ActionRunner
      • ActionRunner.UserApprovedActionDelegate
      • BindableBase
      • ConsoleWriter
      • ConsoleWriterEventArgs
      • ContentOpeningMode
      • CreatorFailureDisplayBox
      • DateFormatConverter
      • DateTimeFormatConverter
      • EnumeratorHelper
      • EnumHelper
      • EnumToCollectionConverter
      • INavigable
      • LazyRenderer
      • MenuControlsHelper
      • MenuControlView
      • MenuControlViewModel
      • MenuControlViewTestViewModel
      • MenuRenderableControlViewModel
      • MvvmVisualState
      • NavCommand
      • NavigableRenderableViewModelBase
      • NavigableViewModelBase
      • PresentationHelper
      • RelayCommand
      • RelayCommand<T>
      • RenderableAssemblyAttribute
      • RenderableContentControl
      • RenderableContentDelayedControl
      • RenderableViewModel
      • RenderContentConverter
      • RenderContentDelayedConverter
      • Renderer
      • Renderer.BaseTypeProperies
      • Renderer.ComponentsCacheItem
      • ReportingLevel
      • SelectedButtonConverter
      • StartUpWindow
      • TestView
      • TimeFormatConverter
      • TooManyObjectsToRenderException
      • ValueDescription
      • WpfLayoutProvider
    • Vortex.Presentation.Wpf.Converters
      • BaseConverter
      • BaseMultiConverter
      • CapitalizeConverter

Class OnlinerString

Class providing access to the STRING type online variable.

Inheritance
System.Object
OnlinerBaseType
OnlinerBaseType<System.String>
OnlinerString
AdsString
Implements
IValueTag
ITwinPrimitive
IVortexElement
System.ComponentModel.INotifyPropertyChanged
IValueBoundaries<System.String>
IOnlineString
IOnline<System.String>
IShadowString
IShadow<System.String>
Inherited Members
OnlinerBaseType<String>.EditValueChange
OnlinerBaseType<String>.ShadowValueChange
OnlinerBaseType<String>.validator
OnlinerBaseType<String>.Validator
OnlinerBaseType<String>.UpdateRead(String)
OnlinerBaseType<String>.SetLastValue
OnlinerBaseType<String>.LastValue
OnlinerBaseType<String>.CwCycle
OnlinerBaseType<String>.cyclic
OnlinerBaseType<String>.cyclicToWrite
OnlinerBaseType<String>.GetLastAvailableValue()
OnlinerBaseType<String>.Edit
OnlinerBaseType<String>.InitializeDefaults()
OnlinerBaseType<String>._shadow
OnlinerBaseType<String>.Shadow
OnlinerBaseType<String>.raw
OnlinerBaseType<String>.Raw
OnlinerBaseType<String>.GetSymbolTail()
OnlinerBaseType<String>.SymbolTail
OnlinerBaseType<String>.Parent
OnlinerBaseType<String>.GetParent()
OnlinerBaseType<String>.IOnline<String>.ValueChanged
OnlinerBaseType<String>.IShadow<String>.ValueChanged
OnlinerBaseType<String>._humanReadable
OnlinerBaseType<String>.HumanReadable
OnlinerBaseType<String>.Subscribe(ValueChangedEventHandlerDelegate)
OnlinerBaseType<String>.UnSubscribe(ValueChangedEventHandlerDelegate)
OnlinerBaseType<String>.PropertyChanged
OnlinerBaseType<String>.ValueChangeEvent
OnlinerBaseType<String>.ShadowValueChangeEvent
OnlinerBaseType<String>.GetValueChangeEventSubscribers()
OnlinerBaseType<String>._attributeName
OnlinerBaseType<String>.AttributeName
OnlinerBaseType<String>.AttributeUnits
OnlinerBaseType<String>.attributeToolTip
OnlinerBaseType<String>.AttributeToolTip
OnlinerBaseType<String>.CyclicReading
OnlinerBaseType<String>.VariableInfo
OnlinerBaseType<String>.Symbol
OnlinerBaseType<String>.HasBeenWritten
OnlinerBaseType<String>.IsToBeRead
OnlinerBaseType<String>.IsToBeWritten
OnlinerBaseType<String>.WriteToPlcIsRequested
OnlinerBaseType<String>.ReadFromPlcIsRequested
OnlinerBaseType<String>.AttributeMaxSet
OnlinerBaseType<String>.attributeMax
OnlinerBaseType<String>.AttributeMaximum
OnlinerBaseType<String>.AttributeMinSet
OnlinerBaseType<String>.attributeMin
OnlinerBaseType<String>.AttributeMinimum
OnlinerBaseType<String>.HasWriteAccess()
OnlinerBaseType<String>.NotifyPropertyChanged(String)
OnlinerBaseType<String>.OnValueChangeEvent(String)
OnlinerBaseType<String>.OnShadowValueChangeEvent(String)
OnlinerBaseType<String>.ReadFromItem()
OnlinerBaseType<String>.WriteItem()
OnlinerBaseType<String>.CreateSymbol(String, String)
OnlinerBaseType<String>.EditValue(String, String)
OnlinerBaseType<String>.ChangeShadowValue(String, String)
OnlinerBaseType<String>.GetDeclaringAssembly()
OnlinerBaseType<String>._translator
OnlinerBaseType<String>.Translator
OnlinerBaseType<String>.IOnline<String>.Symbol
OnlinerBaseType<String>.IOnline<String>.AttributeName
OnlinerBaseType<String>.IOnline<String>.AttributeUnits
OnlinerBaseType<String>.IOnline<String>.Cyclic
OnlinerBaseType<String>.IOnline<String>.Edit
OnlinerBaseType<String>.IOnline<String>.Synchron
OnlinerBaseType<String>.IOnline<String>.Value
OnlinerBaseType<String>.IShadow<String>.Value
OnlinerBaseType<String>.IShadow<String>.Symbol
OnlinerBaseType<String>.IShadow<String>.AttributeName
OnlinerBaseType<String>.IShadow<String>.AttributeUnits
OnlinerBaseType<String>.IShadow<String>.Shadow
OnlinerBaseType.ReadWriteAccess
OnlinerBaseType.MakeReadOnly()
OnlinerBaseType.AttributeFormatString
Namespace: Vortex.Connector.ValueTypes
Assembly: Vortex.Connector.dll
Syntax
public class OnlinerString : OnlinerBaseType<string>, IValueTag, ITwinPrimitive, IVortexElement, INotifyPropertyChanged, IValueBoundaries<string>, IOnlineString, IOnline<string>, IShadowString, IShadow<string>

Constructors

OnlinerString()

Initializes a new instance of the OnlinerString class.

Declaration
public OnlinerString()

OnlinerString(IVortexObject, String, String)

Initializes a new instance of the OnlinerString class.

Declaration
public OnlinerString(IVortexObject parent, string readableTail, string symbolTail)
Parameters
Type Name Description
IVortexObject parent

Parent object of this instance.

System.String readableTail

Human readable tail of this instance.

System.String symbolTail

Symbol tail of this instance.

Properties

Cyclic

Gets translated and interpolated string of Cyclic value. Sets Cyclic value.

Declaration
public override string Cyclic { get; set; }
Property Value
Type Description
System.String
Overrides
Vortex.Connector.ValueTypes.OnlinerBaseType<System.String>.Cyclic

InstanceMaxValue

Gets the max value for this instance.

Declaration
public override string InstanceMaxValue { get; }
Property Value
Type Description
System.String
Overrides
Vortex.Connector.ValueTypes.OnlinerBaseType<System.String>.InstanceMaxValue

InstanceMinValue

Gets the min value for this instance.

Declaration
public override string InstanceMinValue { get; }
Property Value
Type Description
System.String
Overrides
Vortex.Connector.ValueTypes.OnlinerBaseType<System.String>.InstanceMinValue

Synchron

Gets translated and interpolated string of Synchron value. Sets Synchron value.

Declaration
public override string Synchron { get; set; }
Property Value
Type Description
System.String
Overrides
Vortex.Connector.ValueTypes.OnlinerBaseType<System.String>.Synchron

Methods

GetSynchron()

Synchron value when overridden. When not overridden Cyclic value is returned.

Declaration
protected virtual string GetSynchron()
Returns
Type Description
System.String

Synchron

SetSynchron(String)

Sets Synchron value when overridden. When not overriden Cyclic value is set.

Declaration
protected virtual void SetSynchron(string value)
Parameters
Type Name Description
System.String value

Implements

IValueTag
ITwinPrimitive
IVortexElement
System.ComponentModel.INotifyPropertyChanged
IValueBoundaries<T>
IOnlineString
IOnline<T>
IShadowString
IShadow<T>

Extension Methods

IValueTagExtensions.SetCyclicValue<T>(OnlinerBaseType, T)
IValueTagExtensions.SetShadowValue(OnlinerBaseType, Object)
IValueTagExtensions.Cast<T>(T, Object)
IValueTagExtensions.GetCyclicValue(OnlinerBaseType)
IValueTagExtensions.GetLastValue(OnlinerBaseType)
IValueTagExtensions.GetShadowValue(OnlinerBaseType)
In This Article
Back to top

Generated by DocFX | Developed with ❤ at MTS - putting the heart into manufacturing.