Back to Devexpress

HeaderAndFooterTabItemId Enum

aspnetcore-js-devexpress-dot-richedit-761153dc.md

latest2.9 KB
Original Source

HeaderAndFooterTabItemId Enum

Lists commands contained in the Header And Footer tab.

Declaration

ts
export enum HeaderAndFooterTabItemId {
    GoToPageHeader = 227,
    GoToPageFooter = 228,
    GoToPreviousPageHeaderFooter = 230,
    GoToNextPageHeaderFooter = 229,
    LinkHeaderFooterToPrevious = 222,
    ToggleDifferentFirstPage = 231,
    ToggleDifferentOddAndEvenPages = 232,
    ChangeHeaderOffset = 330,
    ChangeFooterOffset = 331,
    ClosePageHeaderFooter = 233
}

Members

NameDescription
ChangeFooterOffset

Identifies the Change Footer Offset command.

| | ChangeHeaderOffset |

Identifies the Change Header Offset command.

| | ClosePageHeaderFooter |

Identifies the Close Page Header Footer command.

| | GoToNextPageHeaderFooter |

Identifies the Go To Next Page Header Footer command.

| | GoToPageFooter |

Identifies the Go To Page Footer command.

| | GoToPageHeader |

Identifies the Go To Page Header command.

| | GoToPreviousPageHeaderFooter |

Identifies the Go To Previous Page Header Footer command.

| | LinkHeaderFooterToPrevious |

Identifies the Link Header Footer To Previous command.

| | ToggleDifferentFirstPage |

Identifies the Toggle Different First Page command.

| | ToggleDifferentOddAndEvenPages |

Identifies the Toggle Different Odd And Even Pages command.

|

Remarks

The HeaderAndFooterTabItemId enum contains identifiers of the Header And Footer tab’s ribbon items. Use an identifier to get the corresponding item and then insert it into a tab or remove the item from the Header And Footer tab.

The example below moves the ToggleDifferentFirstPage item to the first position in the Header And Footer tab:

javascript
var options = DevExpress.RichEdit.createOptions();
var tab = options.ribbon.getTab(DevExpress.RichEdit.RibbonTabType.HeadersFooters);
var ribbonItem = tab.getItem(DevExpress.RichEdit.HeaderAndFooterTabItemId.ToggleDifferentFirstPage);
tab.removeItem(ribbonItem);
tab.insertItem(ribbonItem, 0);
var richContainer = document.getElementById("rich-container");
const richEdit = DevExpress.RichEdit.create(richContainer, options);

To execute the Header And Footer tab’s command, pass the HeaderAndFooterTabCommandId‘s field to the executeCommand(commandId) method.

See Also

RibbonItemId