• Home
• Bloom
• Book
• HtmlDom

C# Class Bloom.Book.HtmlDom

Show file Open project: BloomBooks/BloomDesktop Class Usage Examples

Private Properties

Property	Type	Description
AddKnownStyleIfMissing	void
Ensure	void
EnsureIdsAreUnique	void
GetClasses	IEnumerable
MakeJavascriptElement	System.Xml.XmlElement
MigrateChildren	void
MigrateEditableData	string
RemoveStyleSheetIfFound	void

Public Methods

Method	Description
AddCalendarFoldClassToBody ( XmlDocument dom ) : void
AddClass ( XmlElement e, string className ) : void
AddClassIfMissing ( XmlElement element, string className ) : void
AddCreationType ( string mode ) : void	The Creation Type is either "translation" or "original". This is used to protect fields that should normally not be editable in one or the other. This is a bad name, and we know it!
AddHidePlaceHoldersClassToBody ( XmlDocument dom ) : void
AddJavascriptFile ( string pathToJavascript ) : void
AddJavascriptFileToBody ( string pathToJavascript ) : void
AddPublishClassToBody ( ) : void
AddPublishClassToBody ( XmlDocument dom ) : void	By including this class, we help stylesheets do something different for edit vs. publish mode.
AddRightToLeftClassToBody ( XmlDocument dom ) : void
AddRtlDir ( XmlElement e ) : void
AddStyleSheet ( string path ) : void
AddStyleSheetIfMissing ( string path ) : void
AddStylesheetFromAnotherBook ( HtmlDom sourceBookDom, HtmlDom targetBookDom ) : void
ApplyXSLT ( string pathToXSLT ) : XmlDocument	Applies the XSLT, and returns an XML dom
Clone ( ) : HtmlDom
ConvertHtmlBreaksToNewLines ( string html ) : string
FindChildWithClass ( XmlElement parent, string classVal ) : XmlElement	Find the first child of parent that has the specified class as (one of) its classes.
FindFontsUsedInCss ( string cssContent, HashSet result, bool includeFallbackFonts ) : void	Finds a list of fonts used in the given css
GatherDataBookLanguages ( ) : List	Gives all the unique language codes found in datadiv elements that have data-book
GetAttributeValue ( XmlElement elt, string name ) : string
GetBookSetting ( string key ) : MultiTextBase
GetImageElementUrl ( ElementProxy imgOrDivWithBackgroundImage ) : UrlPathString	Gets the url for the image, either from an img element or any other element that has an inline style with background-image set.
GetImageElementUrl ( GeckoHtmlElement imageElement ) : UrlPathString	Gets the url for the image, either from an img element or any other element that has an inline style with background-image set.
GetImageElementUrl ( XmlElement imageElement ) : UrlPathString	Gets the url for the image, either from an img element or any other element that has an inline style with background-image set.
GetMetaValue ( string name, string defaultValue ) : string
GetOrCreateDataDiv ( XmlNode dom ) : XmlElement
GetTemplateStyleSheets ( ) : IEnumerable
HasMetaElement ( string name ) : bool
HtmlDom ( ) : System
HtmlDom ( XmlDocument domToClone ) : System
HtmlDom ( string xhtml ) : System
IsImgOrSomethingWithBackgroundImage ( XmlElement element ) : bool
MergeClassesIntoNewPage ( XmlElement sourcePage, XmlElement targetPage, string classesToDrop ) : void	Blindly merge the classes from the source into the target.
ProcessPageAfterEditing ( XmlElement destinationPageDiv, XmlElement edittedPageDiv ) : void
RemoveBookSetting ( string key ) : void
RemoveClassesBeginingWith ( XmlElement xmlElement, string classPrefix ) : void
RemoveDirectorySpecificationFromStyleSheetLinks ( ) : void
RemoveExtraBookTitles ( ) : void	Fix BL-2789, where Tok Pisin and Indonesian would show up in the source bubble for book titles, saying the equivalent of "new book" in each language. BasicBook doesn't have that anymore, but this cleans it up in books made from old shells.
RemoveExtraContentTypesMetas ( ) : void
RemoveFileProtocolFromStyleSheetLinks ( ) : void	gecko 11 requires the file://, but modern firefox and chrome can't handle it. Checked also that IE10 works without it.
RemoveMetaElement ( string name ) : void
RemoveMetaElement ( string oldName, Func read, Action write ) : void	Can be called without knowing that the old exists. If it already has the new, the old is just removed. This is just for migration.
RemoveModeStyleSheets ( ) : void
RemoveRtlDir ( XmlElement e ) : void
RemoveXMatterStyleSheets ( ) : void	The chosen xmatter changes, so we need to clear out any old ones
SafeSelectNodes ( string xpath ) : XmlNodeList
SelectChildImgAndBackgroundImageElements ( XmlElement element ) : XmlNodeList
SelectSingleNode ( string xpath ) : XmlElement
SelectSingleNodeHonoringDefaultNS ( string xpath ) : XmlElement
SetBookSetting ( string key, string writingSystemId, string form ) : void
SetElementFromUserStringPreservingLineBreaks ( XmlElement node, string form ) : void
SetImageElementUrl ( ElementProxy imgOrDivWithBackgroundImage, UrlPathString url ) : void	Sets the url attribute either of an img (the src attribute) or a div with an inline style with an background-image rule
SortStyleSheetLinks ( ) : void
UpdateMetaElement ( string name, string value ) : void	creates if necessary, then updates the named in the head of the html
UpdatePageDivs ( ) : void
UpdatePageToTemplate ( HtmlDom pageDom, XmlElement templatePageDiv, string pageId ) : void
ValidateBook ( string descriptionOfBookForErrorLog ) : string

Private Methods

Method	Description
AddKnownStyleIfMissing ( XmlNode child ) : void
Ensure ( bool passes, string message, StringBuilder builder ) : void
EnsureIdsAreUnique ( HtmlDom dom, string elementTag, List ids, StringBuilder builder ) : void
GetClasses ( XmlElement element ) : IEnumerable
MakeJavascriptElement ( string pathToJavascript ) : XmlElement
MigrateChildren ( XmlElement page, string parentClass, XmlElement newPage ) : void	For each div in the page which has the specified class, find the corresponding div with that class in newPage, and replace its contents with the contents of the source page. Also inserts any needed styles we know about.
MigrateEditableData ( XmlElement page, XmlElement template, string lineage ) : string	Replace page in its parent with an element which is a clone of template, but with the contents of page transferred as far as possible. Retain the id of the page. Set its lineage to the supplied value
RemoveStyleSheetIfFound ( string path ) : void

Method Details