Arbortext Command Language > Functions by Alphabetical Listing > window_get_columnview
  
window_get_columnview
window_get_columnview(window, colnamesArr, colwidthArr)
This function enables you to retrieve the Column view settings for a window view.
The window parameter is the window view for which Column view settings are being retrieved.
The colnamesArr parameter is an array of the column names for all columns defined in the .dcf file for the document type. The order of the entries in the array represents the order in which the columns are currently displayed. The first or Outline column is not included in the array, since it cannot be reordered and it never scrolls.
The colwidthArr parameter is an array parallel to colnamesArr that indicates the column width or whether each column is being displayed. Positive values indicate that the column is being displayed and gives the width of the column in pixels. Negative values indicate that the column is not being displayed and the default width of the column if it were showing.
The special column name, *ScrollBoundary*, is used to position the scroll boundary. Columns that come before the scroll boundary do not scroll horizontally and columns that come after the scroll boundary do scroll. Only one scroll boundary can be present. If a scroll boundary is not present, then only the Outline column is not scrolled.
The function returns the number of columns in the arrays. A zero indicates that Column view is not defined for this window. A –1 is returned for other errors.
Related Topics
window_set_columnview function