Skip to main content

TdxSpreadSheetPageControlButton Enum

Enumerates the worksheet creation and tab scroll buttons on the caption bar.

Declaration

TdxSpreadSheetPageControlButton = (
    sspcbFirst,
    sspcbPrev,
    sspcbNext,
    sspcbLast,
    sspcbNew
);

Members

Name
sspcbFirst
sspcbPrev
sspcbNext
sspcbLast
sspcbNew

Remarks

This type is referenced by the TdxSpreadSheetPageControlButtons type. You can use the TdxSpreadSheetPageControl class’ Buttons property to select which buttons should be available in the ExpressSpreadSheet control’s caption bar. Available caption bar buttons include:

Value

Description

Button Example

Active

Inactive

sspcbFirst

The First button scrolls the worksheet tabs row right, showing the leftmost button. This button is the counterpart of the Last button.

The First button is inactive if one of the following conditions are met:

  • The leftmost worksheet tab is already visible;

  • All worksheet tabs and the New Worksheet button fit into the sheet tabs area.

sspcbPrev

The Prev scrolls the worksheet tabs row right by one position. This button is the counterpart of the Next button.

The Prev button is inactive if one of the following conditions are met:

  • The leftmost worksheet tab is already visible;

  • All worksheet tabs and the New Worksheet button fit into the sheet tabs area.

sspcbNext

The Next button scrolls the worksheet tabs row left by one position. This button is the counterpart of the Prev button.

The Next button is inactive if one of the following conditions are met:

  • The rightmost worksheet tab is already visible (if the New Worksheet button is removed from the ExpressSpreadSheet control’s caption bar);

  • The New Worksheet button is already visible, if it is present on the ExpressSpreadSheet control’s caption bar;

  • All worksheet tabs and the New Worksheet button fit into the sheet tabs area.

sspcbLast

The Last button scrolls the worksheet tabs row left, showing either the rightmost worksheet tab or the New Worksheet button. This button is the counterpart of the First button.

The Last button is inactive if one of the following conditions are met:

  • The rightmost worksheet tab is already visible (if the New Worksheet button is removed from the ExpressSpreadSheet control’s caption bar);

  • The New Worksheet button is already visible, if it is present on the ExpressSpreadSheet control’s caption bar;

  • All worksheet tabs and the New Worksheet button fit into the sheet tabs area.

sspcbNew

The New Worksheet button is located to the right from the rightmost worksheet tab and scrolls as a part of the worksheet tabs row. Clicking this button creates a new worksheet.

Unlike the First, Prev, Next, and Last buttons, the New Worksheet button has no inactive status.

See Also