markExcludedHeader Parameter

markExcludedHeader parameter

Use the markExcludedHeader parameter to set or query whether the specified mark should have a header element when it is excluded. A header element is a show element that replaces the elements that are associated with the mark when the mark is excluded. The header element contains text which indicates the number of lines that have been excluded.

Availability

query command
set command

Scope

The specified mark in the current view.

Syntax
query markExcludedHeader.[name | #id]
set markExcludedHeader.[name | #id] { on | off } 
Parameters

name Use the name parameter to specify the name of an existing mark. Mark names may contain any characters but spaces and may not start with the # character.
id Use the id parameter to specify the id of an existing mark.
on Use the on parameter to indicate that the specified mark should be replaced by a mark header element when the mark is excluded from the current view.
off Use the off parameter to indicate that the specified mark should not be replaced by a mark header element when the mark is excluded from the current view.

Description

If you do not specify a mark name or a mark id, the last mark created will be used.

Examples
query markExcludedHeader.test
set markExcludedHeader.test on
set markExcludedHeader.#3 off 
query command
set command
headerMark parameter
mark parameter
markExcluded parameter
markId parameter

name	Use the name parameter to specify the name of an existing mark. Mark names may contain any characters but spaces and may not start with the # character.
id	Use the id parameter to specify the id of an existing mark.
on	Use the on parameter to indicate that the specified mark should be replaced by a mark header element when the mark is excluded from the current view.
off	Use the off parameter to indicate that the specified mark should not be replaced by a mark header element when the mark is excluded from the current view.