File Element

Publish

Platform_KC
On Premises

Description

The File element represents an Author-it File object, and contains all of its properties.

File Icon
Use the File object to link or embed any pictures, OLE objects, or files created and maintained by a separate application. Define how they are formatted in printed and online outputs.

Define different aspects such as size, captions (to 255 characters), borders, and so on. When published, the file is read from disk or from the library, then inserted and formatted as specified. See Inspecting File Object properties.

Note: Insert a File object directly into the text of a topic or in the contents of a book. When included in the book contents pane, it is added to the topic immediately preceding the File object.

Attributes

Attribute Name

Optional

Data Type

Values

wordcount

Yes

Integer

>= 0

Parent Element

Objects

Children

Element

Optional

Object

No

EmbeddedPicture

Yes

EmbeddedPictureExt

Yes

HyperLink

Yes

PrintBorderBottom

Yes

PrintBorderLeft

Yes

PrintBorderRight

Yes

PrintBorderTop

Yes

PrintCaptionPosition

Yes

PrintCaptionLabel

Yes

PrintCaptionTitle

Yes

PrintFilename

Yes

PrintFolder

Yes

PrintOutputFormat

Yes

PrintParagraphStyle

Yes

PrintScaleHeight

Yes

PrintScaleWidth

Yes

PrintSizeHeight

Yes

PrintSizeWidth

Yes

PrintSizingMethod

Yes

PrintSourceType

Yes

HelpBitmapAlignment

Yes

HelpBitmapTransparency

Yes

HelpFileName

Yes

HelpFolder

Yes

HelpOutputFormat

Yes

HelpParagraphStyle

Yes

HelpScaleHeight

Yes

HelpScaleWidth

Yes

HelpSizeHeight

Yes

HelpSizeWidth

Yes

HelpSizingMethod

Yes

HelpSourceType

Yes

HelpVideoPlay

Yes

HelpVideoRepeat

Yes

HelpVideoShowMenuButton

Yes

HelpVideoShowPlaybar

Yes

WebAdditionalFiles

Yes

WebAlignment

Yes

WebAltText

Yes

WebBorder

Yes

WebFileName

Yes

WebFolder

Yes

WebHorizontalSpace

Yes

WebImageMap

Yes

WebOutputFormat

Yes

WebSizeHeight

Yes

WebSizeWidth

Yes

WebSourceType

Yes

WebSpaceVertical

Yes

WebVerticalSpace

Yes

WebVideoRepeat

Yes

WebVideoRepeatTimes

Yes

WebVideoShowControls

Yes

WebVideoStart

Yes

Sample XML

<File>
+ <Object />
<EmbeddedPicture>UEsDBAoAAAAIAFgSPTDTy1DHJxcAAOy5AAAHAAAAU3RyZWFtMe2ayW4bSRBEU5YN0xRNsk2I</EmbeddedPicture>
<EmbeddedPictureExt>wmf</EmbeddedPictureExt>
<HyperLink inherited="true">0</HyperLink>
<PrintBorderBottom inherited="true">0</PrintBorderBottom>
<PrintBorderLeft inherited="true">0</PrintBorderLeft>
<PrintBorderRight inherited="true">0</PrintBorderRight>
<PrintBorderTop inherited="true">0</PrintBorderTop>

<PrintCaptionPosition inherited="true">1</PrintCaptionPosition>
<PrintCaptionLabel inherited="true">2</PrintCaptionLabel>
<PrintCaptionTitle />
<PrintFilename />
<PrintFolder inherited="true" />
<PrintOutputFormat inherited="true">1</PrintOutputFormat>
<PrintParagraphStyle inherited="true">0</PrintParagraphStyle>
<PrintScaleHeight inherited="true">100</PrintScaleHeight>
<PrintScaleWidth inherited="true">100</PrintScaleWidth>
<PrintSizeHeight inherited="true">1</PrintSizeHeight>
<PrintSizeWidth inherited="true">1</PrintSizeWidth>
<PrintSizingMethod inherited="true">1</PrintSizingMethod>
<PrintSourceType inherited="true">3</PrintSourceType>
<HelpBitmapAlignment inherited="true">1</HelpBitmapAlignment>
<HelpBitmapTransparency inherited="true">false</HelpBitmapTransparency>
<HelpFileName />
<HelpFolder inherited="true" />
<HelpOutputFormat>0</HelpOutputFormat>
<HelpParagraphStyle inherited="true">0</HelpParagraphStyle>
<HelpScaleHeight inherited="true">100</HelpScaleHeight>
<HelpScaleWidth inherited="true">100</HelpScaleWidth>
<HelpSizeHeight inherited="true">1</HelpSizeHeight>
<HelpSizeWidth inherited="true">1</HelpSizeWidth>
<HelpSizingMethod inherited="true">1</HelpSizingMethod>
<HelpSourceType inherited="true">4</HelpSourceType>
<HelpVideoPlay inherited="true">false</HelpVideoPlay>
<HelpVideoRepeat inherited="true">false</HelpVideoRepeat>
<HelpVideoShowMenuButton inherited="true">false</HelpVideoShowMenuButton>
<HelpVideoShowPlaybar inherited="true">false</HelpVideoShowPlaybar>
<WebAdditionalFiles />
<WebAlignment inherited="true">Bottom</WebAlignment>
<WebAltText />
<WebBorder inherited="true">0 px</WebBorder>
<WebFileName />
<WebFolder inherited="true" />
<WebHorizontalSpace inherited="true">0 px</WebHorizontalSpace>
<WebImageMap />
<WebOutputFormat>0</WebOutputFormat>
<WebSizeHeight inherited="true">100 %</WebSizeHeight>
<WebSizeWidth inherited="true">100 %</WebSizeWidth>
<WebSourceType inherited="true">5</WebSourceType>
<WebSpaceVertical inherited="true">0 px</WebSpaceVertical>
<WebVerticalSpace inherited="true">0 px</WebVerticalSpace>
<WebVideoRepeat inherited="true">1</WebVideoRepeat>
<WebVideoRepeatTimes inherited="true">1</WebVideoRepeatTimes>
<WebVideoShowControls inherited="true">false</WebVideoShowControls>
<WebVideoStart inherited="true">0</WebVideoStart>
</File>