Class PropString

String properties represent features whose value is a text.

Inheritance

object

HandleObject

Property

PropString

Implements

IDisposable

Inherited Members

Property.Notification

Property.Type

Property.DisplayName

Property.Name

Property.Description

Property.Tooltip

Property.Visibility

Property.IsLocked

Property.IsLikelyLockedByStream

Property.IsAvailable

Property.IsReadonly

Property.IsSelector

Property.SelectedProperties

HandleObject.Dispose(bool)

HandleObject.Dispose()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: ic4

Assembly: ic4dotnet.dll

Syntax

public class PropString : Property, IDisposable

Remarks

The maximum length of the text is indicated by MaxLength.

PropString instances are created in multiple ways:

• By directly querying a PropertyMap for a string property:
  • Find(PropIdString)
  • FindString(string)
  • TryFind(PropIdString, out PropString)
  • TryFindString(string, out PropString)
• By casting a Property object obtained from one of the functions returning generic property objects:
  • Find(string)
  • TryFind(string, out Property)
  • Features
  • All
  • SelectedProperties

Properties

MaxLength

The maximum length of the string that can be stored in this property

Declaration

public ulong MaxLength { get; }

Property Value

Type	Description
ulong	The maximum length of the string that can be stored in this property

Value

The current value of this property

The value is only writable is the property's writability is not restricted. See IsLocked, IsReadonly, IsAvailable.

Declaration

public string Value { get; set; }

Property Value

Type	Description
string	The current value of this property

Exceptions

Type	Condition
IC4Exception	Check ErrorCode and ToString() for details.

Implements

IDisposable