AX#

Search Results for

    Show / Hide Table of Contents

    Class OnlinerString

    Class providing access to the STRING type online variable.

    Inheritance
    object
    OnlinerBase
    OnlinerBase<string>
    OnlinerString
    WebApiString
    Implements
    ITwinPrimitive
    ITwinElement
    INotifyPropertyChanged
    IValueBoundaries<string>
    IOnlineString
    IOnline<string>
    IShadowString
    IShadow<string>
    Inherited Members
    OnlinerBase<string>.validator
    OnlinerBase<string>.EditValueChange
    OnlinerBase<string>.ShadowValueChange
    OnlinerBase<string>.Validator
    OnlinerBase<string>.SetLastValue
    OnlinerBase<string>.CyclicToWrite
    OnlinerBase<string>.Edit
    OnlinerBase<string>.Shadow
    OnlinerBase<string>.Raw
    OnlinerBase<string>.AttributeUnits
    OnlinerBase<string>.AttributeToolTip
    OnlinerBase<string>.GetAttributeToolTip(CultureInfo)
    OnlinerBase<string>.VariableInfo
    OnlinerBase<string>.ReadFromPlcIsRequested
    OnlinerBase<string>.AttributeMaximum
    OnlinerBase<string>.AttributeMinimum
    OnlinerBase<string>.LastValue
    OnlinerBase<string>.IsSubscribed
    OnlinerBase<string>.UpdateRead(string)
    OnlinerBase<string>.GetLastAvailableValue()
    OnlinerBase<string>.InitializeDefaults()
    OnlinerBase<string>.ShadowValueChangeEvent
    OnlinerBase<string>.HasWriteAccess()
    OnlinerBase<string>.ReadFromItem()
    OnlinerBase<string>.WriteItem()
    OnlinerBase<string>.GetDeclaringAssembly()
    OnlinerBase<string>.FromOnlineToShadow()
    OnlinerBase<string>.FromShadowToOnline()
    OnlinerBase.PollingInterval
    OnlinerBase.AttributeFormatString
    OnlinerBase.SymbolTail
    OnlinerBase.Parent
    OnlinerBase.SubscribeForPeriodicReading()
    OnlinerBase.ReadWriteAccess
    OnlinerBase.MakeReadOnly()
    OnlinerBase.ReadOnce
    OnlinerBase.MakeReadOnce()
    OnlinerBase.GetSymbolTail()
    OnlinerBase.GetParent()
    OnlinerBase.Poll()
    OnlinerBase.Interpreter
    OnlinerBase.Subscribe(ValueChangedEventHandlerDelegate)
    OnlinerBase.Subscribe()
    OnlinerBase.UnSubscribe(ValueChangedEventHandlerDelegate)
    OnlinerBase.AccessStatus
    OnlinerBase.Symbol
    OnlinerBase.AttributeName
    OnlinerBase.GetAttributeName(CultureInfo)
    OnlinerBase.HumanReadable
    OnlinerBase.GetHumanReadable(CultureInfo)
    OnlinerBase.CreateSymbol(string, string)
    OnlinerBase.ValueChangeEvent
    OnlinerBase.GetValueChangeEventSubscribers()
    OnlinerBase.OnValueChangeEvent(object)
    OnlinerBase.PropertyChanged
    OnlinerBase.NotifyPropertyChanged(string)
    OnlinerBase.AddToPeriodicQueue()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: AXSharp.Connector.ValueTypes
    Assembly: AXSharp.Connector.dll
    Syntax
    public class OnlinerString : OnlinerBase<string>, ITwinPrimitive, ITwinElement, INotifyPropertyChanged, IValueBoundaries<string>, IOnlineString, IOnline<string>, IShadowString, IShadow<string>

    Constructors

    | Edit this page View Source

    OnlinerString()

    Initializes a new instance of the OnlinerString class.

    Declaration
    public OnlinerString()
    | Edit this page View Source

    OnlinerString(ITwinObject, string, string)

    Initializes a new instance of the OnlinerString class.

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

    Parent object of this instance.

    string readableTail

    Human readable tail of this instance.

    string symbolTail

    Symbol tail of this instance.

    Properties

    | Edit this page View Source

    Cyclic

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

    Declaration
    public override string Cyclic { get; set; }
    Property Value
    Type Description
    string
    Overrides
    OnlinerBase<string>.Cyclic
    | Edit this page View Source

    InstanceMaxValue

    Gets the max value for this instance.

    Declaration
    public override string InstanceMaxValue { get; }
    Property Value
    Type Description
    string
    Overrides
    OnlinerBase<string>.InstanceMaxValue
    | Edit this page View Source

    InstanceMinValue

    Gets the min value for this instance.

    Declaration
    public override string InstanceMinValue { get; }
    Property Value
    Type Description
    string
    Overrides
    OnlinerBase<string>.InstanceMinValue

    Methods

    | Edit this page View Source

    GetAsync()

    Gets the value of this OnlinerString.

    Declaration
    public override Task<string> GetAsync()
    Returns
    Type Description
    Task<string>

    GetAsync()

    Overrides
    OnlinerBase<string>.GetAsync()
    | Edit this page View Source

    GetAsync(CultureInfo)

    Gets value translated in give CultureInfo

    Declaration
    public override Task<string> GetAsync(CultureInfo culture)
    Parameters
    Type Name Description
    CultureInfo culture

    Culture into which the value should be translated.

    Returns
    Type Description
    Task<string>

    Translated value.

    Overrides
    OnlinerBase<string>.GetAsync(CultureInfo)
    | Edit this page View Source

    GetCyclic(CultureInfo)

    Gets Cyclic translated with provided CultureInfo

    Declaration
    public override string GetCyclic(CultureInfo culture = null)
    Parameters
    Type Name Description
    CultureInfo culture

    Desired culture.

    Returns
    Type Description
    string

    Translated value

    Overrides
    OnlinerBase<string>.GetCyclic(CultureInfo)
    | Edit this page View Source

    SetAsync(string)

    Sets the value of this OnlinerString.

    Declaration
    public override Task<string> SetAsync(string value)
    Parameters
    Type Name Description
    string value

    Value to be set

    Returns
    Type Description
    Task<string>
    Overrides
    OnlinerBase<string>.SetAsync(string)

    Implements

    ITwinPrimitive
    ITwinElement
    INotifyPropertyChanged
    IValueBoundaries<T>
    IOnlineString
    IOnline<T>
    IShadowString
    IShadow<T>

    Extension Methods

    TranslatorExtension.Translate(ITwinElement, string, CultureInfo)
    TwinObjectExtensions.HasAttribute<T>(ITwinElement)
    TwinObjectExtensions.StartPolling(ITwinElement, int, object)
    TwinObjectExtensions.StopPolling(ITwinElement, object)
    TwinPrimitiveExtensions.GetAttribute<T>(ITwinElement)
    TwinPrimitiveExtensions.GetPropertyInfoViaSymbol(ITwinElement)
    TwinPrimitiveExtensions.GetCyclicValue<T>(OnlinerBase)
    TwinPrimitiveExtensions.GetLastValue<T>(OnlinerBase)
    TwinPrimitiveExtensions.GetShadowValue<T>(OnlinerBase)
    TwinPrimitiveExtensions.SetCyclicValue<T>(OnlinerBase, T)
    TwinPrimitiveExtensions.SetShadowValue<T>(OnlinerBase, T)
    • Edit this page
    • View Source
    In this article
    Back to top Generated by DocFx. © MTS spol. s r.o., MTS spol. s r.o., and awesome contributors