GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

HTMLIsFieldBlock Function

Overview

The HTMLIsFieldBlock function checks a specified token or the currently loaded element for being a block type field or pseudo element.

Syntax/Parameters

Syntax

boolean = HTMLIsFieldBlock ( handle hObject | TOKEN token );

Parameters

hObject

A handle to an SGML Object. Or,

token

An TOKEN (or dword) specifying an HTML element token.

Return Value

A boolean value as non-zero for a match condition or FALSE on no match or failure. See HTML Element Testers for HTML_IS_ definitions of non-zero conditions. Use the GetLastError function to retrieve a formatted error code.

Remarks

Field elements are pseudo tags that do not impact rendering. The following elements are consider a block field (meant to behave like an HTML division):

Field: Auto-Index        SGML_FIELD_NAME_AUTO_INDEX

Field: Auto-TOC          SGML_FIELD_NAME_AUTO_TOC

Field: Include-Text      SGML_FIELD_NAME_INCLUDE_TEXT

Field: List              SGML_FIELD_NAME_LIST

Field: Named-Area        SGML_FIELD_NAME_NAMED_AREA

Field: Page              SGML_FIELD_NAME_PAGE_DATA

Field: Rule-Page         SGML_FIELD_NAME_RULE_PAGE

Field: Rule-Table        SGML_FIELD_NAME_RULE_TABLE

Note that by default, the SGML element parser does not process fields.

The CSS ‘display’ property is not inspected for this function.

Related Functions

HTMLIsBlockBasicElement — Tests an HTML element as being a basic block.

HTMLIsBlockElement — Tests an HTML element as being a block.

HTMLIsBodyContainerElement — Tests an HTML element as being a body container.

HTMLIsContainerElement — Tests an HTML element as being a container element.

HTMLIsField — Tests an HTML element as being an SGML field.

HTMLIsFieldInline — Tests an HTML element as being an SGML field pseudo inline element.

HTMLIsFlowContainerElement — Tests an HTML element as being a flow container.

HTMLIsFormControlElement — Tests an HTML element as being a form control.

HTMLIsHeadElement — Tests an HTML element as being a head element.

HTMLIsInlineElement — Tests an HTML element as being an inline element.

HTMLIsInlineStyleElement — Tests an HTML element as being an inline style element.

HTMLIsListContainer — Tests an HTML element as being a list container.

HTMLIsListItem — Tests an HTML element as being a list item.

HTMLIsRevisionElement — Tests an HTML element as being a revision element.

HTMLIsSelfContainedElement — Tests an HTML element as being a self-contained element.

HTMLIsTableElement — Tests an HTML element as being a table element.

HTMLIsTableFrameElement — Tests an HTML element as being a table frame.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.