класс Aspose::Words::Saving::BookmarksOutlineLevelCollection

BookmarksOutlineLevelCollection class

Коллекция отдельных уровней оглавления закладок. Чтобы узнать больше, посетите статью документации Working with Bookmarks.

class BookmarksOutlineLevelCollection : public System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String, int32_t>>

Методы

МетодОписание
Add(const System::String&, int32_t)Добавляет закладку в коллекцию.
begin()
begin() const
BookmarksOutlineLevelCollection()
cbegin() const
cend() const
Clear()Удаляет все элементы из коллекции.
Contains(const System::String&)Определяет, содержит ли коллекция закладку с указанным именем.
end()
end() const
get_Count()Получает количество элементов, содержащихся в коллекции.
GetEnumerator() overrideВозвращает объект‑перечислитель, который можно использовать для перебора всех элементов в коллекции.
GetType() const override
idx_get(const System::String&)Получает или задает уровень контура закладки по имени закладки.
idx_get(int32_t)Получает или задает уровень контура закладки по указанному индексу.
idx_set(const System::String&, int32_t)Получает или задает уровень контура закладки по имени закладки.
idx_set(int32_t, int32_t)Получает или задает уровень контура закладки по указанному индексу.
IndexOfKey(const System::String&)Возвращает нулевой индекс указанной закладки в коллекции.
Is(const System::TypeInfo&) const override
Remove(const System::String&)Удаляет закладку с указанным именем из коллекции.
RemoveAt(int32_t)Удаляет закладку по указанному индексу.
static Type()
virtualizeBeginConstIterator() const override
virtualizeBeginIterator() override
virtualizeEndConstIterator() const override
virtualizeEndIterator() override

Typedefs

Типовое определениеОписание
const_iterator
iterator
iterator_holder_type
virtualized_iterator
virtualized_iterator_element

Примечания

Ключ — строковое имя закладки без учёта регистра. Значение — целочисленный уровень контура закладки.

Bookmark outline level may be a value from 0 to 9. Specify 0 and Word bookmark will not be displayed in the document outline. Specify 1 and Word bookmark will be displayed in the document outline at level 1; 2 for level 2 and so on.

Примеры

Показывает, как установить уровни контура для закладок.

auto doc = System::MakeObject<Aspose::Words::Document>();
auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);

// Вставьте закладку, внутри которой вложена другая закладка.
builder->StartBookmark(u"Bookmark 1");
builder->Writeln(u"Text inside Bookmark 1.");

builder->StartBookmark(u"Bookmark 2");
builder->Writeln(u"Text inside Bookmark 1 and 2.");
builder->EndBookmark(u"Bookmark 2");

builder->Writeln(u"Text inside Bookmark 1.");
builder->EndBookmark(u"Bookmark 1");

// Вставьте другую закладку.
builder->StartBookmark(u"Bookmark 3");
builder->Writeln(u"Text inside Bookmark 3.");
builder->EndBookmark(u"Bookmark 3");

// При сохранении в .pdf закладки можно открыть через выпадающее меню и использовать в качестве якорей большинством читалок.
// Закладки также могут иметь числовые значения уровней структуры,
// что позволяет записям более низкого уровня скрывать дочерние записи более высокого уровня при сворачивании в просмотрщике.
auto pdfSaveOptions = System::MakeObject<Aspose::Words::Saving::PdfSaveOptions>();
System::SharedPtr<Aspose::Words::Saving::BookmarksOutlineLevelCollection> outlineLevels = pdfSaveOptions->get_OutlineOptions()->get_BookmarksOutlineLevels();

outlineLevels->Add(u"Bookmark 1", 1);
outlineLevels->Add(u"Bookmark 2", 2);
outlineLevels->Add(u"Bookmark 3", 3);

ASSERT_EQ(3, outlineLevels->get_Count());
ASSERT_TRUE(outlineLevels->Contains(u"Bookmark 1"));
ASSERT_EQ(1, outlineLevels->idx_get(0));
ASSERT_EQ(2, outlineLevels->idx_get(u"Bookmark 2"));
ASSERT_EQ(2, outlineLevels->IndexOfKey(u"Bookmark 3"));

// Мы можем удалить два элемента, чтобы осталась только обозначение уровня структуры для "Bookmark 1".
outlineLevels->RemoveAt(2);
outlineLevels->Remove(u"Bookmark 2");

// Существует девять уровней структуры. Их нумерация будет оптимизирована во время операции сохранения.
// В этом случае уровни "5" и "9" станут "2" и "3".
outlineLevels->Add(u"Bookmark 2", 5);
outlineLevels->Add(u"Bookmark 3", 9);

doc->Save(get_ArtifactsDir() + u"BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);

// Очистка этой коллекции сохранит закладки и разместит их все на одном уровне структуры.
outlineLevels->Clear();

См. также