IsCurrentObjectReadOnly method (WinStudio scripts)

Applies To

IWSIDOCollection interface

Definition

Returns a Boolean value indicating whether the current object in a collection is read-only.

Syntax

object.IsCurrentObjectReadOnly( )

  Part   Description
object The name of a valid IDO collection object.

Remarks

This method applies to an entire record (row), not just a single column or component within the grid. To get a row to be read-only, you must have:

  • A property on the IDO with the Read-Only Record attribute selected.
  • The value of that property on that row to be true.

A return value of:

  • TRUE indicates that the current object in the collection is read-only.
  • FALSE indicates that the object is not read-only.

If the specified IDO collection has focus, use this method. If the specified IDO collection might not have focus, use the IsObjectReadOnly method.

Example

Sub Main()
    If ThisForm.PrimaryIDOCollection.IsCurrentObjectReadOnly() Then
        Application.ShowMessage("This field is read-only.")
    End If
End Sub