Frameset class
Frameset class
Represents a frames page or a single frame on a frames page. To learn more, visit the Programming with Documents documentation article.
Remarks
If the Frameset.child_framesets property contains items, this instance is a frames page, otherwise it is a single frame.
Constructors
| Name | Description |
|---|---|
| Frameset() | The default constructor. |
Properties
| Name | Description |
|---|---|
| child_framesets | Gets the collection of child frames and frames pages. |
| frame_default_url | Gets or sets the web page URL or document file name to display in this frame. |
| is_frame_link_to_file | Gets or sets a value indicating whether the web page or document file name specified in the Frameset.frame_default_url property is an external resource the frame is linked with. |
Examples
Shows how to access frames on-page.
# Document contains several frames with links to other documents.
doc = aw.Document(file_name=MY_DIR + 'Frameset.docx')
self.assertEqual(3, doc.frameset.child_framesets.count)
# We can check the default URL (a web page URL or local document) or if the frame is an external resource.
self.assertEqual('https://file-examples-com.github.io/uploads/2017/02/file-sample_100kB.docx', doc.frameset.child_framesets[0].child_framesets[0].frame_default_url)
self.assertTrue(doc.frameset.child_framesets[0].child_framesets[0].is_frame_link_to_file)
self.assertEqual('Document.docx', doc.frameset.child_framesets[1].frame_default_url)
self.assertFalse(doc.frameset.child_framesets[1].is_frame_link_to_file)
# Change properties for one of our frames.
doc.frameset.child_framesets[0].child_framesets[0].frame_default_url = 'https://github.com/aspose-words/Aspose.Words-for-.NET/blob/master/Examples/Data/Absolute%20position%20tab.docx'
doc.frameset.child_framesets[0].child_framesets[0].is_frame_link_to_file = False
See Also
- module aspose.words.framesets