ReadOnly Property

Home Page (Objects) |  Overview |  FAQ |  Reference

Applies to: Document object, TextDocument object

Gets or sets whether a document is read-only in Developer Studio.

Syntax

object.ReadOnly [=boolean]

Parameters

object

An expression that evaluates to a Document object or a TextDocument object.

boolean

A Boolean that sets whether the document is read-only. Possible values are:

• True   Makes the document read-only in Developer Studio.
  
  
• False   Makes the document read/write in Developer Studio, but does not change its status on disk. For example, if the document is read-only on disk, it remains read-only.

Return Values

The ReadOnly property returns one of the following values:

• True   The document is read-only.
  
  
• False   The document is not read-only.

Remarks

The ReadOnly property has the Boolean type.

Example

The following example makes the active document read-only:

ActiveDocument.ReadOnly = True