Aspose::Words::Framesets::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.

class Frameset : public System::Object

Methods

MethodDescription
Frameset()
get_ChildFramesets() constGets the collection of child frames and frames pages.
get_FrameDefaultUrl()Gets or sets the web page URL or document file name to display in this frame.
get_IsFrameLinkToFile()Gets or sets a value indicating whether the web page or document file name specified in the FrameDefaultUrl property is an external resource the frame is linked with.
GetType() const override
Is(const System::TypeInfo&) const override
set_FrameDefaultUrl(const System::String&)Setter for Aspose::Words::Framesets::Frameset::get_FrameDefaultUrl.
set_IsFrameLinkToFile(bool)Setter for Aspose::Words::Framesets::Frameset::get_IsFrameLinkToFile.
static Type()

Examples

Shows how to access frames on-page.

// Document contains several frames with links to other documents.
auto doc = MakeObject<Document>(MyDir + u"Frameset.docx");

// We can check the default URL (a web page URL or local document) or if the frame is an external resource.
ASSERT_EQ(u"https://file-examples-com.github.io/uploads/2017/02/file-sample_100kB.docx",
          doc->get_Frameset()->get_ChildFramesets()->idx_get(0)->get_ChildFramesets()->idx_get(0)->get_FrameDefaultUrl());
ASSERT_TRUE(doc->get_Frameset()->get_ChildFramesets()->idx_get(0)->get_ChildFramesets()->idx_get(0)->get_IsFrameLinkToFile());

ASSERT_EQ(u"Document.docx", doc->get_Frameset()->get_ChildFramesets()->idx_get(1)->get_FrameDefaultUrl());
ASSERT_FALSE(doc->get_Frameset()->get_ChildFramesets()->idx_get(1)->get_IsFrameLinkToFile());

// Change properties for one of our frames.
doc->get_Frameset()->get_ChildFramesets()->idx_get(0)->get_ChildFramesets()->idx_get(0)->set_FrameDefaultUrl(
    u"https://github.com/aspose-words/Aspose.Words-for-.NET/blob/master/Examples/Data/Absolute%20position%20tab.docx");
doc->get_Frameset()->get_ChildFramesets()->idx_get(0)->get_ChildFramesets()->idx_get(0)->set_IsFrameLinkToFile(false);

See Also

Aspose::Words::Framesets::FramesetCollection class