Headers and Footers

Classes

Class	Description
TXTextControl.HeaderFooter	An instance of the HeaderFooter class represents a header or footer in a Text Control document.
TXTextControl.HeaderFooterCollection	An instance of the HeaderFooterCollection class contains the headers and footers in a Text Control document represented through objects of the type HeaderFooter.
TXTextControl.HeaderFooterEventArgs	The HeaderFooterEventArgs class provides data for the TextControl.HeaderFooterActivated and TextControl.HeaderFooterDeactivated events.
TXTextControl.PageNumberField	The PageNumberField class represents a field in a header or footer of a Text Control document that automatically displays the current page number.
TXTextControl.PageNumberFieldCollection	An instance of the PageNumberFieldCollection class contains the page number fields in a header or footer of a Text Control document.

Constructors

Constructor	Description
TXTextControl.PageNumberField	Creates a new instance of the PageNumberField class.

Events

Event	Description
TXTextControl.TextControl.HeaderFooterActivated	Occurs when a header or footer gets the current text input position from another part of the document such as a textframe or the main text.
TXTextControl.TextControl.HeaderFooterDeactivated	Occurs when a header or footer loses the current text input position and another part of the document such as a textframe or the main text gets it.

Methods

Method	Description
TXTextControl.HeaderFooter.Activate	Activates a header or a footer.
TXTextControl.HeaderFooter.AddUndoUnit	Adds the current state of the header or footer to the undo stack.
TXTextControl.HeaderFooter.Deactivate	Deactivates a header or a footer.
TXTextControl.HeaderFooter.Find	Finds a text string in a header or footer.
TXTextControl.HeaderFooter.GetTextFields	Returns a collection containing text fields of the specified types.
TXTextControl.HeaderFooterCollection.Add	Adds a new header or footer to a Text Control document or to a certain section of the document.
TXTextControl.HeaderFooterCollection.CopyTo	Copies the elements of the collection to an array, starting at a particular index.
TXTextControl.HeaderFooterCollection.GetEnumerator	Returns an enumerator that can be used to iterate through the collection.
TXTextControl.HeaderFooterCollection.GetItem	Gets a particular header or footer from the collection.
TXTextControl.HeaderFooterCollection.Remove	Removes a header or footer from a Text Control document or from a certain section.
TXTextControl.PageNumberField.PageNumberDialog	Opens a dialog box to alter the formatting and numbering attributes of the page number field.
TXTextControl.PageNumberFieldCollection.Add	Inserts a new page number field at the current input position of a header or footer.
TXTextControl.PageNumberFieldCollection.Clear	Removes all page number fields contained in the collection from the document.
TXTextControl.PageNumberFieldCollection.CopyTo	Copies the elements of the collection to an array, starting at a particular index.
TXTextControl.PageNumberFieldCollection.GetItem	Gets a particular page number field from the collection.
TXTextControl.PageNumberFieldCollection.Remove	Removes a page number from a header or footer of a Text control document.
TXTextControl.TextControl.OnHeaderFooterActivated	Raises the HeaderFooterActivated event.
TXTextControl.TextControl.OnHeaderFooterDeactivated	Raises the HeaderFooterDeactivated event.

Properties

Property	Description
TXTextControl.HeaderFooter.ApplicationFields	Gets a collection of all Microsoft Word or Heiler HighEdit fields that have been created or imported from a Microsoft Word or RTF document.
TXTextControl.HeaderFooter.Barcodes	Gets a collection of all barcodes contained in a header or footer.
TXTextControl.HeaderFooter.Charts	Gets a collection of all charts contained in a header or footer.
TXTextControl.HeaderFooter.Comments	Gets a collection of all comments in the header or footer.
TXTextControl.HeaderFooter.ConnectedToPrevious	Gets or sets a value specifying whether the header or footer is connected with the header or footer of the previous section.
TXTextControl.HeaderFooter.Distance	Gets or sets the distance, in twips, of a header or footer to the top or bottom of the page.
TXTextControl.HeaderFooter.DocumentLinks	Gets a collection of all links in a header or footer which point to targets in the same document.
TXTextControl.HeaderFooter.DocumentTargets	Gets a collection of all targets in a header or footer.
TXTextControl.HeaderFooter.Drawings	Gets a collection of all drawings contained in a header or footer.
TXTextControl.HeaderFooter.EditableRegions	Gets a collection of all editable regions in the header or footer.
TXTextControl.HeaderFooter.FormFields	Gets a collection of all form fields contained in a header or footer.
TXTextControl.HeaderFooter.Frames	Gets a collection of all images, textframes, charts, barcodes and drawings in a header or footer.
TXTextControl.HeaderFooter.HypertextLinks	Gets a collection of all hypertext links the header or footer contains.
TXTextControl.HeaderFooter.Images	Gets a collection of all images the header or footer contains.
TXTextControl.HeaderFooter.Lines	Gets a collection of all text lines the header or footer contains.
TXTextControl.HeaderFooter.MisspelledWords	Gets a collection of all misspelled words the header or footer contains.
TXTextControl.HeaderFooter.PageNumberFields	Gets a collection of page number fields in the header or footer.
TXTextControl.HeaderFooter.Paragraphs	Gets a collection of all paragraphs the header or footer contains.
TXTextControl.HeaderFooter.SectionNumber	Returns the number of the section to which the header or footer belongs.
TXTextControl.HeaderFooter.Selection	Gets or sets the current selection in a header or footer.
TXTextControl.HeaderFooter.SubTextParts	Gets a collection of all subtextparts in the header or footer.
TXTextControl.HeaderFooter.Tables	Gets a collection of all tables in the header or footer.
TXTextControl.HeaderFooter.TablesOfContents	Gets a collection of all tables of contents in the header or footer.
TXTextControl.HeaderFooter.TextChars	Gets a collection of all characters the header or footer contains.
TXTextControl.HeaderFooter.TextFields	Gets a collection of all standard text fields in the header or footer.
TXTextControl.HeaderFooter.TextFrames	Gets a collection of all text frames contained in a header or footer.
TXTextControl.HeaderFooter.TrackedChanges	Gets a collection of all changes made in the header or footer.
TXTextControl.HeaderFooter.Type	Gets the type of the header or footer.
TXTextControl.HeaderFooterCollection.Count	Gets the number of elements contained in the collection.
TXTextControl.HeaderFooterEventArgs.HeaderFooter	Gets an object that represents the header or footer which causes the event.
TXTextControl.PageNumberField.NumberFormat	Gets or sets the number format.
TXTextControl.PageNumberField.ShowNumberOfPages	Gets or sets a value indicating whether the field shows the page number or the total number of pages.
TXTextControl.PageNumberField.StartNumber	Gets or sets the page number for the first page.
TXTextControl.PageNumberFieldCollection.Item	Gets the field with the specified number from the collection.
TXTextControl.ServerTextControl.HeadersAndFooters	Gets a collection of all headers and footers the current document contains.
TXTextControl.TextControl.HeaderFooterActivationStyle	Gets or sets a value specifying the activation style for headers and footers.
TXTextControl.TextControl.HeaderFooterFrameStyle	Gets or sets a value specifying the frame for activated headers and footers.
TXTextControl.TextControl.HeadersAndFooters	Gets a collection of all headers and footers the current document contains.