TPUHELP.HLB  —  SET(RECORD_ATTRIBUTE)
  SET(RECORD_ATTRIBUTE)

     Sets or alters any of three possible attributes for the specified
     record or records.  The attributes you can set for a record are its
     left margin, its modifiability, and its visibility.

  Syntax

     SET (RECORD_ATTRIBUTE, {mark | range | buffer},
                            {DISPLAY_VALUE | LEFT_MARGIN},
                            {display_setting_integer | margin_setting_integer})

                                        or

     SET (RECORD_ATTRIBUTE, [marker | range | buffer], MODIFIABLE, [ON | OFF])

  Parameters

      RECORD_ATTRIBUTE         A keyword indicating that the SET built-in is
                               being used to specify or change a record
                               attribute.

      marker                   The marker marking the the record whose
                               attribute you want to set.

      range                    The range containing the records whose
                               attribute you want to set.

      buffer                   The buffer containing the records for which
                               you want to set an attribute.  When you
                               specify a buffer for the second parameter,
                               the record attribute is applied to all
                               records in the buffer.

      DISPLAY_VALUE            A keyword indicating that you want to affect
                               the visibility of the record.  If you specify
                               the DISPLAY_VALUE keyword as the third
                               parameter, you must specify for the fourth
                               parameter an integer providing a display
                               setting.

      LEFT_MARGIN              A keyword indicating that you want to specify
                               the left margin for the specified records.
                               If you specify the LEFT_MARGIN keyword as the
                               third parameter, you must specify for the
                               fourth parameter an integer providing a left
                               margin value.

      display_setting_integer  An integer value from -127 to +127.  This is
                               the display setting.  To determine whether a
                               record is to be visible or invisible in a
                               given window, DECTPU compares the record's
                               display setting to the window's display
                               setting.  (A window's display setting is
                               specified with SET (DISPLAY_VALUE).) If the
                               record's setting is greater than or equal to
                               the window's setting, DECTPU makes the record
                               visible in that window; otherwise, DECTPU
                               makes the record invisible.

      margin_setting_integer   An integer that is the column in which the
                               left margin should be set.  The value must be
                               between 1 and the value of the right margin.
                               (The maximum valid value for the right margin
                               is 960.)

      MODIFIABLE               A keyword indicating that you want to
                               determine whether the specified records are
                               modifiable.  If you specify the MODIFIABLE
                               keyword as the third parameter, you must
                               specify either ON or OFF as the fourth
                               parameter.

      ON                       A keyword making records modifiable.  Note,
                               if a buffer has been set as unmodifiable
                               using SET (MODIFIABLE), you cannot make a
                               record in that buffer modifiable using SET
                               (RECORD_ATTRIBUTE).  If the buffer is
                               modifiable, however, you can use SET
                               (RECORD_ATTRIBUTE) to make a record
                               unmodifiable.

      OFF                      A keyword making records unmodifiable.

  Comments

     You can set only one attribute with each call to SET
     (RECORD_ATTRIBUTE).  For example, you cannot change visibility and
     modifiability using just one call.  To set more than one record
     attribute, use multiple calls to SET (RECORD_ATTRIBUTE).

     When you set an attribute for multiple records, each record gets the
     same value.  For example, if you specify a range of records and a value
     for the left margin attribute, all records in the range receive the
     same left margin value.

     You cannot change the left margin of an unmodifiable record.  You can
     change the display value of a record at any time.  You can change the
     modifiability of a record if the buffer is modifiable.

  Examples

     1.  The following statement sets the left margin of all records in the
         current buffer to column 3:

         SET (RECORD_ATTRIBUTE, CURRENT_BUFFER, LEFT_MARGIN, 3);

     2.  The following statements make the records in the range
         "select_range" invisible in the current window:

         SET (DISPLAY_VALUE, CURRENT_WINDOW, 0);
         SET (RECORD_ATTRIBUTE, select_range, -1);

     3.  The following statement makes the current record unmodifiable:

         SET (RECORD_ATTRIBUTE, MARK (FREE_CURSOR), MODIFIABLE, OFF);

  Related Topics

     GET_INFO(BUFFER_VARIABLE)          GET_INFO(MARKER_VARIABLE)
     GET_INFO(WINDOW_VARIABLE)          SET(DISPLAY_VALUE)
     SET(ERASE_UNMODIFIABLE)            SET(LEFT_MARGIN)
     SET(MODIFIABLE)
Close Help