docSection (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Word Processing functions

Types of variables

docSection

Presentation

Example

Properties specific to the description of docSection variables

See also

docSection (Type of variable)

In french: docSection

The docSection type is used to define the advanced characteristics of a section found in a document or paragraph.

At document level:

the docSection type is used to find out the general information of document.
the docSection type is used to modify the entire information for all document sections.

At paragraph level:

the docSection type is used to get information about the paragraphs belonging to the same section.
the docSection type is used to modify information about the paragraphs belonging to the same section.

The characteristics of this section can be defined and changed using different WLanguage properties.

Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

// Retrieve the Word Processing control
MyDoc is Document <- WP_MyDoc
// Retrieve the document orientation
Info(MyDoc.Section.Orientation)
// Switch the document orientation to landscape
MyDoc.Section.Orientation = docLandscape

Remarks

Properties specific to the description of docSection variables

The following properties can be used to handle a section:


Property name		Type used	Effect
Header			Characteristics of page header
	Header.FirstPageInherited	Boolean	True if the header of the first page in the section is identical to the one of previous section. False otherwise.
	Header.FirstPage	docHeaderFooter variable	Characteristics of header for the first page in the section.
	Header.EvenPageInherited	Boolean	True if the header of even pages in the section is identical to the one of previous section. False otherwise.
	Header.EvenPage	docHeaderFooter variable	Characteristics of header for the even pages in the section.
	Header.OddPageInherited	Boolean	True if the header of odd pages in the section is identical to the one of previous section. False otherwise.
	Header.OddPage	docHeaderFooter variable	Characteristics of header for the odd pages in the section.
PageHeight		Real	Page height for the pages in the section (expressed in millimeters).
PageWidth		Real	Page width for the pages in the section (expressed in millimeters).
BottomMargin		Real	Bottom margin for the pages in the section (expressed in millimeters).
RightMargin		Real	Right margin for the pages in the section (expressed in millimeters).
HeaderMargin		Real	Margin for the page headers of section (expressed in millimeters).
LeftMargin		Real	Left margin for the pages in the section (expressed in millimeters).
TopMargin		Real	Top margin for the pages in the section (expressed in millimeters).
FooterMargin		Real	Margin for the page footers of section (expressed in millimeters).
Multicolumn		docFormatMulticolumn variable	Options for managing the multicolumn of the section.
Number		Integer	Section number. This property is read-only.
Orientation		Integer constant	Orientation of section: docLandscape: all the pages found in the section are in Landscape mode. docPortrait: all pages found in the section are in Portrait mode.
PageFooter			Characteristics of footer.
	PageFooter.FirstPageInherited	Boolean	True if the footer of the first page in the section is identical to the one of previous section. False otherwise.
	PageFooter.FirstPage	docHeaderFooter variable	Characteristics of footer for the first page in the section.
	PageFooter.EvenPageInherited	Boolean	True if the footer of even pages in the section is identical to the one of previous section. False otherwise.
	PageFooter.EvenPage	docHeaderFooter variable	Characteristics of footer for the even pages in the section.
	PageFooter.OddPageInherited	Boolean	True if the footer of odd pages in the section is identical to the one of previous section. False otherwise.
	PageFooter.OddPage	docHeaderFooter variable	Characteristics of footer for the odd pages in the section.
FirstPageDifferent		Boolean	True if, for this section, the headers and footers of the first page in the section differ from the ones of previous section, False otherwise.
Type		Integer constant	Type of section break that will be applied to all the paragraphs found in the section: ssSectionBreak: Section break to next page. ssSectionBreakContinuous: Section break on the same page. This type of section break is used to separate a 2-column section from a 1-column section on the same page for example. This type of section is not compatible with the modifications regarding the document size, orientation or margins. ssSectionBreakOddPage: Section break to next odd page. ssSectionBreakEvenPage: Section break to next even page.