public class Frameset
extends java.lang.Object
To learn more, visit the Programming with Documents documentation article.
Remarks:
If the getChildFramesets() property contains items, this instance is a frames page, otherwise it is a single frame.
Examples:
Shows how to access frames on-page.
// Document contains several frames with links to other documents.
Document doc = new Document(getMyDir() + "Frameset.docx");
Assert.assertEquals(3, doc.getFrameset().getChildFramesets().getCount());
// We can check the default URL (a web page URL or local document) or if the frame is an external resource.
Assert.assertEquals("https://file-examples-com.github.io/uploads/2017/02/file-sample_100kB.docx",
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).getFrameDefaultUrl());
Assert.assertTrue(doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile());
Assert.assertEquals("Document.docx", doc.getFrameset().getChildFramesets().get(1).getFrameDefaultUrl());
Assert.assertFalse(doc.getFrameset().getChildFramesets().get(1).isFrameLinkToFile());
// Change properties for one of our frames.
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).setFrameDefaultUrl("https://github.com/aspose-words/Aspose.Words-for-.NET/blob/master/Examples/Data/Absolute%20position%20tab.docx");
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile(false);
| Modifier and Type | Method and Description |
|---|---|
FramesetCollection |
getChildFramesets()
Gets the collection of child frames and frames pages.
|
java.lang.String |
getFrameDefaultUrl()
Gets the web page URL or document file name to display in this frame.
|
boolean |
isFrameLinkToFile()
Gets a value indicating whether the web page or document file name specified in the
getFrameDefaultUrl() / setFrameDefaultUrl(java.lang.String) property is an external resource the frame is linked with. |
void |
isFrameLinkToFile(boolean value)
Sets a value indicating whether the web page or document file name specified in the
getFrameDefaultUrl() / setFrameDefaultUrl(java.lang.String) property is an external resource the frame is linked with. |
void |
setFrameDefaultUrl(java.lang.String value)
Sets the web page URL or document file name to display in this frame.
|
public java.lang.String getFrameDefaultUrl()
Examples:
Shows how to access frames on-page.
// Document contains several frames with links to other documents.
Document doc = new Document(getMyDir() + "Frameset.docx");
Assert.assertEquals(3, doc.getFrameset().getChildFramesets().getCount());
// We can check the default URL (a web page URL or local document) or if the frame is an external resource.
Assert.assertEquals("https://file-examples-com.github.io/uploads/2017/02/file-sample_100kB.docx",
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).getFrameDefaultUrl());
Assert.assertTrue(doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile());
Assert.assertEquals("Document.docx", doc.getFrameset().getChildFramesets().get(1).getFrameDefaultUrl());
Assert.assertFalse(doc.getFrameset().getChildFramesets().get(1).isFrameLinkToFile());
// Change properties for one of our frames.
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).setFrameDefaultUrl("https://github.com/aspose-words/Aspose.Words-for-.NET/blob/master/Examples/Data/Absolute%20position%20tab.docx");
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile(false);
public void setFrameDefaultUrl(java.lang.String value)
Examples:
Shows how to access frames on-page.
// Document contains several frames with links to other documents.
Document doc = new Document(getMyDir() + "Frameset.docx");
Assert.assertEquals(3, doc.getFrameset().getChildFramesets().getCount());
// We can check the default URL (a web page URL or local document) or if the frame is an external resource.
Assert.assertEquals("https://file-examples-com.github.io/uploads/2017/02/file-sample_100kB.docx",
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).getFrameDefaultUrl());
Assert.assertTrue(doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile());
Assert.assertEquals("Document.docx", doc.getFrameset().getChildFramesets().get(1).getFrameDefaultUrl());
Assert.assertFalse(doc.getFrameset().getChildFramesets().get(1).isFrameLinkToFile());
// Change properties for one of our frames.
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).setFrameDefaultUrl("https://github.com/aspose-words/Aspose.Words-for-.NET/blob/master/Examples/Data/Absolute%20position%20tab.docx");
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile(false);
value - The web page URL or document file name to display in this frame.public boolean isFrameLinkToFile()
getFrameDefaultUrl() / setFrameDefaultUrl(java.lang.String) 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.
Document doc = new Document(getMyDir() + "Frameset.docx");
Assert.assertEquals(3, doc.getFrameset().getChildFramesets().getCount());
// We can check the default URL (a web page URL or local document) or if the frame is an external resource.
Assert.assertEquals("https://file-examples-com.github.io/uploads/2017/02/file-sample_100kB.docx",
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).getFrameDefaultUrl());
Assert.assertTrue(doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile());
Assert.assertEquals("Document.docx", doc.getFrameset().getChildFramesets().get(1).getFrameDefaultUrl());
Assert.assertFalse(doc.getFrameset().getChildFramesets().get(1).isFrameLinkToFile());
// Change properties for one of our frames.
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).setFrameDefaultUrl("https://github.com/aspose-words/Aspose.Words-for-.NET/blob/master/Examples/Data/Absolute%20position%20tab.docx");
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile(false);
getFrameDefaultUrl() / setFrameDefaultUrl(java.lang.String) property is an external resource the frame is linked with.public void isFrameLinkToFile(boolean value)
getFrameDefaultUrl() / setFrameDefaultUrl(java.lang.String) 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.
Document doc = new Document(getMyDir() + "Frameset.docx");
Assert.assertEquals(3, doc.getFrameset().getChildFramesets().getCount());
// We can check the default URL (a web page URL or local document) or if the frame is an external resource.
Assert.assertEquals("https://file-examples-com.github.io/uploads/2017/02/file-sample_100kB.docx",
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).getFrameDefaultUrl());
Assert.assertTrue(doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile());
Assert.assertEquals("Document.docx", doc.getFrameset().getChildFramesets().get(1).getFrameDefaultUrl());
Assert.assertFalse(doc.getFrameset().getChildFramesets().get(1).isFrameLinkToFile());
// Change properties for one of our frames.
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).setFrameDefaultUrl("https://github.com/aspose-words/Aspose.Words-for-.NET/blob/master/Examples/Data/Absolute%20position%20tab.docx");
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile(false);
value - A value indicating whether the web page or document file name specified in the getFrameDefaultUrl() / setFrameDefaultUrl(java.lang.String) property is an external resource the frame is linked with.public FramesetCollection getChildFramesets()
Examples:
Shows how to access frames on-page.
// Document contains several frames with links to other documents.
Document doc = new Document(getMyDir() + "Frameset.docx");
Assert.assertEquals(3, doc.getFrameset().getChildFramesets().getCount());
// We can check the default URL (a web page URL or local document) or if the frame is an external resource.
Assert.assertEquals("https://file-examples-com.github.io/uploads/2017/02/file-sample_100kB.docx",
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).getFrameDefaultUrl());
Assert.assertTrue(doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile());
Assert.assertEquals("Document.docx", doc.getFrameset().getChildFramesets().get(1).getFrameDefaultUrl());
Assert.assertFalse(doc.getFrameset().getChildFramesets().get(1).isFrameLinkToFile());
// Change properties for one of our frames.
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).setFrameDefaultUrl("https://github.com/aspose-words/Aspose.Words-for-.NET/blob/master/Examples/Data/Absolute%20position%20tab.docx");
doc.getFrameset().getChildFramesets().get(0).getChildFramesets().get(0).isFrameLinkToFile(false);