FieldCitation class
FieldCitation class
Implements the CITATION field. To learn more, visit the Working with Fields documentation article.
Remarks
Inserts the contents of the Source element with a specified Tag element using a bibliographic style.
Inheritance: FieldCitation → Field
Constructors
| Name | Description |
|---|---|
| FieldCitation() | The default constructor. |
Properties
| Name | Description |
|---|---|
| another_source_tag | Gets or sets a value that matches the Tag element’s value of another source to be included in the citation. |
| display_result | Gets the text that represents the displayed field result. (Inherited from Field) |
| end | Gets the node that represents the field end. (Inherited from Field) |
| format | Gets a FieldFormat object that provides typed access to field’s formatting. (Inherited from Field) |
| format_language_id | Gets or sets the language ID that is used in conjunction with the specified bibliographic style to format the citation in the document. |
| is_dirty | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. (Inherited from Field) |
| is_locked | Gets or sets whether the field is locked (should not recalculate its result). (Inherited from Field) |
| locale_id | Gets or sets the LCID of the field. (Inherited from Field) |
| page_number | Gets or sets a page number associated with the citation. |
| prefix | Gets or sets a prefix that is prepended to the citation. |
| result | Gets or sets text that is between the field separator and field end. (Inherited from Field) |
| separator | Gets the node that represents the field separator. Can be None.(Inherited from Field) |
| source_tag | Gets or sets a value that matches the Tag element’s value of the source to insert. |
| start | Gets the node that represents the start of the field. (Inherited from Field) |
| suffix | Gets or sets a suffix that is appended to the citation. |
| suppress_author | Gets or sets whether the author information is suppressed from the citation. |
| suppress_title | Gets or sets whether the title information is suppressed from the citation. |
| suppress_year | Gets or sets whether the year information is suppressed from the citation. |
| type | Gets the Microsoft Word field type. (Inherited from Field) |
| volume_number | Gets or sets a volume number associated with the citation. |
Methods
| Name | Description |
|---|---|
| get_field_code() | Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. (Inherited from Field) |
| get_field_code(include_child_field_codes) | Returns text between field start and field separator (or field end if there is no separator). (Inherited from Field) |
| remove() | Removes the field from the document. Returns a node right after the field. If the field’s end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns None.(Inherited from Field) |
| unlink() | Performs the field unlink. (Inherited from Field) |
| update() | Performs the field update. Throws if the field is being updated already. (Inherited from Field) |
| update(ignore_merge_format) | Performs a field update. Throws if the field is being updated already. (Inherited from Field) |
Examples
Shows how to work with CITATION and BIBLIOGRAPHY fields.
# Open a document containing bibliographical sources that we can find in
# Microsoft Word via References -> Citations & Bibliography -> Manage Sources.
doc = aw.Document(MY_DIR + 'Bibliography.docx')
builder = aw.DocumentBuilder(doc)
builder.write('Text to be cited with one source.')
# Create a citation with just the page number and the author of the referenced book.
field_citation = builder.insert_field(aw.fields.FieldType.FIELD_CITATION, True).as_field_citation()
# We refer to sources using their tag names.
field_citation.source_tag = 'Book1'
field_citation.page_number = '85'
field_citation.suppress_author = False
field_citation.suppress_title = True
field_citation.suppress_year = True
self.assertEqual(' CITATION Book1 \\p 85 \\t \\y', field_citation.get_field_code())
# Create a more detailed citation which cites two sources.
builder.insert_paragraph()
builder.write('Text to be cited with two sources.')
field_citation = builder.insert_field(aw.fields.FieldType.FIELD_CITATION, True).as_field_citation()
field_citation.source_tag = 'Book1'
field_citation.another_source_tag = 'Book2'
field_citation.format_language_id = 'en-US'
field_citation.page_number = '19'
field_citation.prefix = 'Prefix '
field_citation.suffix = ' Suffix'
field_citation.suppress_author = False
field_citation.suppress_title = False
field_citation.suppress_year = False
field_citation.volume_number = 'VII'
self.assertEqual(' CITATION Book1 \\m Book2 \\l en-US \\p 19 \\f "Prefix " \\s " Suffix" \\v VII', field_citation.get_field_code())
# We can use a BIBLIOGRAPHY field to display all the sources within the document.
builder.insert_break(aw.BreakType.PAGE_BREAK)
field_bibliography = builder.insert_field(aw.fields.FieldType.FIELD_BIBLIOGRAPHY, True).as_field_bibliography()
field_bibliography.format_language_id = '5129'
self.assertEqual(' BIBLIOGRAPHY \\l 5129', field_bibliography.get_field_code())
doc.update_fields()
doc.save(ARTIFACTS_DIR + 'Field.field_citation.docx')
See Also
- module aspose.words.fields
- class Field