C# Class SIL.FieldWorks.FDO.DomainImpl.ScrSectionFactory

Show file Open project: sillsdev/FieldWorks

Public Methods

Method	Description
CreateEmptySection ( IScrBook book, int iSection ) : IScrSection	Create a new section, to be owned by the given book. Since the StTexts are empty, this version of the function is generic (i.e. the new section may be made either an intro section or a scripture text section by the calling code).
CreateScrSection ( IScrBook book, int iSection, string contentText, ITsTextProps contentTextProps, bool isIntro ) : IScrSection	Create a new section, to be owned by the given book. The section will be an intro section if the isIntro flag is set to `true` The contents of the first content paragraph are filled with a single run as requested. The start and end references for the section are set based on where it's being inserted in the book.
CreateSection ( IScrBook book, int iSection, bool isIntro, bool createHeadingPara, bool createContentPara ) : IScrSection	Creates a section with optional heading/content paragraphs.

Method Details

CreateEmptySection() public method

Create a new section, to be owned by the given book. Since the StTexts are empty, this version of the function is generic (i.e. the new section may be made either an intro section or a scripture text section by the calling code).

public CreateEmptySection ( IScrBook book, int iSection ) : IScrSection
book	IScrBook	The book where the new section will be created
iSection	int	The zero-based index of the new section
return	IScrSection

CreateScrSection() public method

Create a new section, to be owned by the given book. The section will be an intro section if the isIntro flag is set to true The contents of the first content paragraph are filled with a single run as requested. The start and end references for the section are set based on where it's being inserted in the book.

public CreateScrSection ( IScrBook book, int iSection, string contentText, ITsTextProps contentTextProps, bool isIntro ) : IScrSection
book	IScrBook	The book where the new section will be created
iSection	int	The zero-based index of the new section
contentText	string	The text to be used as the first para in the new section /// content
contentTextProps	ITsTextProps	The character properties to be applied to the first /// para in the new section content
isIntro	bool	True to create an intro section, false to create a /// normal scripture section
return	IScrSection

CreateSection() public method

Creates a section with optional heading/content paragraphs.

public CreateSection ( IScrBook book, int iSection, bool isIntro, bool createHeadingPara, bool createContentPara ) : IScrSection
book	IScrBook	The book where the new section will be created
iSection	int	The zero-based index of the new section
isIntro	bool	True to create an intro section, false to create a /// normal scripture section
createHeadingPara	bool	if true, heading paragraph will be created
createContentPara	bool	if true, content paragraph will be created
return	IScrSection