Aspose::Words::Framesets::FramesetCollection class

FramesetCollection class

Represents a collection of instances of the Frameset class. To learn more, visit the Programming with Documents documentation article.

class FramesetCollection : public System::Collections::Generic::IEnumerable<System::SharedPtr<Aspose::Words::Framesets::Frameset>>

Methods

MethodDescription
FramesetCollection()
GetEnumerator() overrideReturns an enumerator that iterates through the collection.
get_Count()Gets the number of frames or frames pages contained in the collection.
idx_get(int32_t)Gets a frame or frames page at the specified index.

Typedefs

TypedefDescription
const_iteratorConst iterator type.
iteratorIterator type.
iterator_holder_typeA collection type whose iterator types is used as iterator types in the current collection.
virtualized_iteratorVirtualized type.
virtualized_iterator_elementVirtualized element type.

Examples

Shows how to access frames on-page.

// Document contains several frames with links to other documents.
auto doc = System::MakeObject<Aspose::Words::Document>(System::String(get_MyDir() + u"Frameset.docx"));

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

ASSERT_EQ(doc->get_Frameset()->get_ChildFramesets()->idx_get(1)->get_FrameDefaultUrl(), u"Document.docx");
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