Log in
Contact
Forum
XmlApi - pdx:addDateAndHour
- addBackgroundImage
- addFooter
- addHeader
- addLineNumbering
- addMacroFromDoc
- addPageBorders
- addProperties
- addSection
- createCharacterStyle
- createListStyle
- createParagraphStyle
- docxSettings
- importHeadersAndFooters
- importListStyle
- importStyles
- modifyPageLayout
- parseStyles
- removeFooters
- removeHeaders
- setBackgroundColor
- setDefaultFont
- setDocumentDefaultStyles
- setEncodeUTF8
- setLanguage
- setMarkAsFinal
- addBookmark
- addBreak
- addChart
- addComment
- addCrossReference
- addDateAndHour
- addEndnote
- addExternalFile
- addFootnote
- addFormElement
- addHeading
- addImage
- addLink
- addList
- addMathEquation
- addMergeField
- addPageNumber
- addShape
- addSimpleField
- addStructuredDocumentTag
- addTable
- addTableContents
- addText
- addTextBox
- addWordML
- embedHTML
- clearBlocks
- deleteTemplateBlock
- modifyInputFields
- processTemplate
- rawSearchAndReplace
- removeTemplateVariable
- replaceListVariable
- replacePlaceholderImage
- replaceTableVariable
- replaceVariableByExternalFile
- replaceVariableByHtml
- replaceVariableByText
- replaceVariableByWordFragment
- replaceVariableByWordML
- setTemplateSymbol
- setTemplateBlockSymbol
pdx:addDateAndHour
Inserts the current date and/or hour into the Word document.
Description
Element definition
This element allows the insertion of the current date and/or hour in different formats.
The default format is dd/MM/yyyy H:mm:ss that will render something like 30/01/2014 7:35:48, where:
- dd stands for the day in two digit format
- MM stands for the month in two digit format
- yyyy stands for the year in 4 digit format
- H, mm and ss correspond to hours, minutes and seconds respectively
This default format can be changed at will through the format option. For example, if you use as format: dd' of 'MMMM' of 'yyyy' at 'HH:mm', it will result in something like this: 30 of January of 2014 at 07:35.
The DOCX standard offers us multiple possibilities that may be explored via this link.
The most usual options are summarized in the following table:
| Format Specifier | Description |
|---|---|
| d | The day of the month: 1 to 31 |
| dd | The day of the month: 01 to 31 |
| ddd | The day of the month: short name |
| dddd | The day of the month: full name |
| M | The month of the year: 1 to 12 |
| MM | The month of the year: 01 to 12 |
| MMM | The month of the year: short name |
| MMMM | The month of the year: full name |
| y | The year (max. two digits): 0 to 99 |
| yy | The year (two digits): 00 to 99 |
| yyyy | The year (four digits) |
| h | The hour of the day (12 hours clock): 1 to 12 |
| hh | The hour of the day (12 hours clock): 01 to 12 |
| H | The hour of the day: 1 to 23 |
| HH | The hour of the day: 01 to 23 |
| m | The minutes: 1 to 59 |
| mm | The minutes: 01 to 59 |
| s | The seconds: 1 to 59 |
| ss | The seconds: 01 to 59 |
| tt | AM or PM |
You may also include the date and hour within other element (paragraph, table, header, footer...) creating a WordFragment.
Attributes and sub-elements
| Key | Description |
|---|---|
| dateFormat | A string with the required date format. The default value is: dd/MM/yyyy H:mm:ss. |
This is an array including all general paragraph wide options.
The possible keys and values of this array are:
| Key | Description |
|---|---|
| pStyle | Word style to be used. Run parseStyles() method to check all available paragraph styles. |
| backgroundColor | Hexadecimal color value: FF0000, 000000... |
| bidi | Set to true for right to left languages like Hebrew or Arabic. |
| bold | If true the text will be shown in bold characters. |
| border | Available values are:
|
| borderBottom | Overwrites the general border type for the bottom border of the paragraph. |
| borderLeft | Overwrites the general border type for the left border of the paragraph. |
| borderTop | Overwrites the general border type for the top border of the paragraph. |
| borderRight | Overwrites the general border type for the right border of the paragraph. |
| borderColor | Hexadecimal color value: FF0000, 000000... |
| borderBottomColor | Overwrites the general border color for the bottom border of the paragraph. |
| borderLeftColor | Overwrites the general border color for the left border of the paragraph. |
| borderTopColor | Overwrites the general border color for the top border of the paragraph. |
| borderRightColor | Overwrites the general border color for the right border of the paragraph. |
| borderSpacing | Separation between border and text in points. |
| borderBottomSpacing | Overwrites the general border spacing for the bottom border of the paragraph. |
| borderLeftSpacing | Overwrites the general border spacing for the left border of the paragraph. |
| borderTopSpacing | Overwrites the general border spacing for the top border of the paragraph. |
| borderRightSpacing | Overwrites the general border spacing for the right border of the paragraph. |
| borderWidth | Border width in eigths of a point. |
| borderBottomWidth | Overwrites the general border width for the bottom border of the paragraph. |
| borderLeftWidth | Overwrites the general border width for the left border of the paragraph. |
| borderTopWidth | Overwrites the general border width for the top border of the paragraph. |
| borderRightWidth | Overwrites the general border width for the right border of the paragraph. |
| caps | If true displays text in capital letters. |
| color | Hexadecimal color value: 'FF0000', '000000'... |
| contextualSpacing | If true ignores spacing above and below the paragraph whenever the neighbouring paragraphs use the same Word style (false by default). |
| doubleStrikeThrough | If true displays text in doubleStrikeThrough. |
| em | Emphasis mark type: 'none', 'dot', 'circle', 'comma', 'underDot'. |
| firstLineIndent | First line indentation in twentieths of a point (twips). |
| font | Font family: 'Arial', Calibri'... |
| fontSize | Font size in points. |
| hanging | Paragraph hanging in twentieths of a point (twips). |
| headingLevel | The heading level if you want this paragraph to be a heading. |
| italic | If true displays the text in italics. |
| indentLeft | Left margin in points. |
| indentRight | Right margin in points. |
| keepLines | Keeps (whenever possible) all the current paragraph lines on the same page (default value is false). |
| keepNext | Keeps (whenever possible) in the same page the current paragraph with next paragraph (default value is false). |
| lineSpacing | 120, 240 (standard), 360, 480... (in twentieths of a point). |
| pageBreakBefore | If true forces a page break before the paragraph. |
| position | Position value. Positive value for raised and negative value for lowered. |
| rtl | Set to true for right to left languages like Hebrew or Arabic. |
| scaling | Scaling value, 100 is the default value. |
| smallCaps | If true displays text in small capital letters. |
| spacingBottom | Bottom padding in twentieths of a point. |
| spacingTop | Top padding in twentieths of a point. |
| strikeThrough | If true displays text in strikethrough. |
| tabPositions | Each entry is an associative array with the following keys and values:
|
| textAlign | Text alignment within paragraph. Possible values are: center, right, both and distribute. |
| textDirection | Text flow direction within a table cell. Possible values are: lrTb, tbRl, btLr, lrTbV, tbRlV and tbLrV. |
| underline | Underlines text. Possible values are: single, words, double, dotted, dash and wave. |
| underlineColor | Underlines text with a color: 'FF0000', '000000'... |
| vanish | Uses a vanish style. |
| widowControl | Prevents Word from printing the last line of a paragraph by itself at the top of the page (widow) or the first line of a paragraph at the bottom of a page (orphan). |
| wordWrap | Allows line breaking at character level (default value is false). |
Code samples
Example #1
config.xml
content.xml
settings.xml
PHP code
The resulting Word document looks like:
