IncludeTag (Web API 2021)

All Superinterfaces:

EnumHTMLTags, Tag

All Known Implementing Classes:

IncludeTagImpl
```
public interface IncludeTag
extends Tag
```
Since:

MicroStrategy Web 8.0.2

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ATTR_NAME_FILE_NAME`	The constant name of the attribute `file`.
`static java.lang.String`	`TAG_NAME_INCLUDE`	The constant name of the `IncludeTag`.

Fields inherited from interface com.microstrategy.web.tags.EnumHTMLTags
ATT_ACTION, ATT_ALIGN, ATT_ALT, ATT_AUTOCOMPLETE, ATT_BORDER, ATT_CELLPADDING, ATT_CELLSPACING, ATT_CHECKED, ATT_CLASS, ATT_CMD_FORMAT_TYPE, ATT_CMDID, ATT_CMDLVL, ATT_COLS, ATT_COLSPAN, ATT_DG, ATT_DIALOG, ATT_DISABLED, ATT_FOR, ATT_HEIGHT, ATT_HREF, ATT_HSPACE, ATT_ID, ATT_IFRAME, ATT_LANGUAGE, ATT_MAXLENGTH, ATT_METHOD, ATT_MODAL, ATT_NAME, ATT_NOWRAP, ATT_ONCHANGE, ATT_ONCLICK, ATT_ONFOCUS, ATT_ONKEYDOWN, ATT_ONKEYUP, ATT_ONMOUSEOUT, ATT_ONMOUSEOVER, ATT_ONSUBMIT, ATT_PARAM, ATT_PLACEHOLDER, ATT_READONLY, ATT_REL, ATT_ROWS, ATT_ROWSPAN, ATT_SCRIPT_CLASS, ATT_SELECTED, ATT_SIZE, ATT_SRC, ATT_STYLE, ATT_SUMMARY, ATT_TARGET, ATT_TITLE, ATT_TY, ATT_TYPE, ATT_VALIGN, ATT_VALUE, ATT_VALUE_ABSBOTTOM, ATT_VALUE_ABSMIDDLE, ATT_VALUE_BOTTOM, ATT_VALUE_BUTTON, ATT_VALUE_CHECKBOX, ATT_VALUE_DEFAULT, ATT_VALUE_EMBED, ATT_VALUE_FALSE, ATT_VALUE_HIDDEN, ATT_VALUE_IMAGE, ATT_VALUE_JAVASCRIPT, ATT_VALUE_LEFT, ATT_VALUE_MAX, ATT_VALUE_MIDDLE, ATT_VALUE_MIN, ATT_VALUE_NUMBER, ATT_VALUE_POST, ATT_VALUE_RADIO, ATT_VALUE_SUBMIT, ATT_VALUE_TEXT, ATT_VALUE_TOP, ATT_VALUE_TRUE, ATT_VSPACE, ATT_WIDTH, TAG_NAME_ANCHOR, TAG_NAME_CELL, TAG_NAME_DIV, TAG_NAME_HEADER, TAG_NAME_IFRAME, TAG_NAME_IMAGE, TAG_NAME_INPUT, TAG_NAME_LABEL, TAG_NAME_MAP, TAG_NAME_OPTION, TAG_NAME_ROW, TAG_NAME_SCRIPT, TAG_NAME_SELECT, TAG_NAME_SPAN, TAG_NAME_STYLE, TAG_NAME_TABLE, TAG_NAME_TBODY, TAG_NAME_TEXTAREA, TAG_NAME_THEAD

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getFileName()`	Returns the location of the file It is actually the value of the attribute `ATTR_NAME_FILE_NAME`.
`LayoutTag`	`getTemplateContent()`	Returns the tree representation of the included template source
`void`	`populateTemplate(java.lang.String fileName, LayoutSource layoutSource, LayoutParser layoutParser)`	Retrieves the content of the included external file and sets the content on the tag

Methods inherited from interface com.microstrategy.web.tags.Tag
addChild, addChild, addChild, addTextChild, addTextChild, doEndTag, doStartTag, getAttribute, getAttributeNames, getChildren, getContent, getCssClass, getDeepCopy, getId, getLineNumber, getPreserveCase, getRootTag, getSealed, getStyle, getTagName, isClosedRequired, isContentInline, isDynamic, removeChildren, render, render, renderCloseTag, renderOpenTag, renderOpenTag, replaceContent, setAttribute, setAttributes, setCssClass, setDynamic, setId, setIsClosedRequired, setIsContentInline, setLineNumber, setPreserveCase, setRootTag, setSealed, setStyle, setTagName

- Field Detail
  - TAG_NAME_INCLUDE
```
static final java.lang.String TAG_NAME_INCLUDE
```
    The constant name of the IncludeTag.
    
    See Also:
    
    Constant Field Values
  - ATTR_NAME_FILE_NAME
```
static final java.lang.String ATTR_NAME_FILE_NAME
```
    The constant name of the attribute file. The value is the location of a layout template file
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getFileName
```
java.lang.String getFileName()
```
    Returns the location of the file It is actually the value of the attribute ATTR_NAME_FILE_NAME.
    
    Returns:
    
    the value of the attribute ATTR_NAME_FILE_NAME.
  - getTemplateContent
```
LayoutTag getTemplateContent()
```
    Returns the tree representation of the included template source
    
    Returns:
    
    LayoutTag
  - populateTemplate
```
void populateTemplate(java.lang.String fileName,
                      LayoutSource layoutSource,
                      LayoutParser layoutParser)
```
    Retrieves the content of the included external file and sets the content on the tag
    
    Parameters:
    
    fileName - - The location of the external file
    
    layoutSource - - The layoutSource to load the external file
    
    layoutParser - - The layoutParser to parse the external file