ScrollingControlViewModel - класс

Элемент управления областью с прокруткой страниц документа.

Definition

Пространство имён: Tessa.UI.Controls.Scrolling
Сборка: Tessa.UI (в Tessa.UI.dll) Версия: 4.0.4
C#
public sealed class ScrollingControlViewModel : ViewModel<EmptyModel>, 
	IFilePagingControlModel, INotifyPropertyChanged, IScrollingControlViewModel, IAsyncDisposable
Inheritance
Object    NotificationObject    NotificationUIObject    ViewModelEmptyModel    ScrollingControlViewModel
Implements
INotifyPropertyChanged, IAsyncDisposable, IScrollingControlViewModel, IFilePagingControlModel

Конструкторы

ScrollingControlViewModel(IPreviewPageExtractor, PagingSelectorModel, ILogger) Создаёт экземпляр класса с указанием его зависимостей.
ScrollingControlViewModel(IPreviewPageExtractor, IScrollingPageDispatcher, PagingSelectorModel, ILogger, Boolean) Создаёт экземпляр класса с указанием его зависимостей и объекта IScrollingPageDispatcher.

Свойства

ContentScale Коэффициент масштабирования страницы относительно размеров области, в которую страница вписывается. По умолчанию значение равно 1.0 и соответствует вписыванию страницы в отображаемую область на 100%. При приближении устанавливаемого значения к 1.0 оно округляется.
CurrentPage Номер текущей страницы, отсчитываемый от единицы, или 0, если текущей страницы нет.
CurrentPageText Текст, отображаемый в поле с текущим номером страницы.
DisableChangingPageMode Отключает кнопку переключения между постраничным отображением документа и скроллингом.
DisableFullScreen Отключает кнопку переключения в полноэкранный режим.
FullScreenCommand Переключает отображение в полноэкранный режим, если такое переключение разрешено.
FullScreenMode Признак того, что контрол отображается в полноэкранном режиме.
IsLargerContentScale Признак того, что страница отображается в большем масштабе, чем размеры отведённой под неё области, т.е. коэффициент ContentScale больше 1.0. Определяет необходимость отобразить горизонтальную прокрутку.
MaxContentScale Максимально разрешённый коэффициент масштабирования ContentScale.
MaxImageWidth Максимальная ширина полноформатной страницы документа или null, если ширина не ограничена. По умолчанию обычно устанавливается равной ширине экрана, на котором размещается основное окно приложения.
MaxPreviewImageWidth Максимальная ширина страницы документа в формате предпросмотра или null, если ширина не ограничена. По умолчанию равна 200.0.
MinContentScale Минимальный разрешённый коэффициент масштабирования ContentScale.
Model Модель для текущей модели представления.
(Унаследован от ViewModelTModel)
NavigateFirstCommand Переходит к первой странице документа, если такой переход возможен.
NavigateFirstCommandClosure Команда для кнопки перехода на первую страницу.
NavigateLastCommand Переходит к последней странице документа, если такой переход возможен.
NavigateLastCommandClosure Команда для кнопки перехода на последнюю страницу.
NavigateNextCommand Переходит к следующей странице документа, если такой переход возможен.
NavigateNextCommandClosure Команда для кнопки перехода на следующую страницу.
NavigatePrevCommand Переходит к предыдущей странице документа, если такой переход возможен.
NavigatePrevCommandClosure Команда для кнопки перехода на предыдущую страницу.
OneHundredPercentCommand Команда, изменяющая масштаб на вписывание в область, что соответствует значению ContentScale, равному 1.0.
PageOptions Настройки отображения области предпросмотра. Объект используется для выполнения расширений через делегаты. Для изменения вызовите метод ApplyOptions(IPreviewPageOptions).
Pages Объекты с информацией по полноформатным страницам документа.
PagingModeCommand Переключает режим просмотра документа с прокрутки на постраничный, если такое переключение разрешено.
PagingPanelIsCollapsed Признак того, что верхняя панель изменения страниц и типа просмотра не отображается. Не влияет на возможность использовать эти функции из API, горячими клавишами и жестами. По умолчанию false.
PreviewPages Объекты с информацией по страницам документа в формате предпросмотра.
PreviewPath Полный путь к файлу, превью которого выполняется, или null, если превью отсутствует.
Scope
(Унаследован от ViewModelTModel)
TotalPages Общее количество страниц.
TotalPagesText Общее количество страниц или 0, если документ не загружен. Указывается строка текста, фактически отображаемая в элементе управления.
WidthToHeightMultiplier Множитель, на который должна быть умножена ширина страницы, чтобы получить её высоту. При прокрутке считается, что ширина и высота каждой страницы одинакова (если это не так, то по краям отображаются полосы). По умолчанию значение равно 1.0.
WidthToHeightMultiplierScaled Множитель, на который должна быть умножена ширина страницы, чтобы получить её высоту, с учётом коэффициента масштабирования ContentScale. При прокрутке считается, что ширина и высота каждой страницы одинакова (если это не так, то по краям отображаются полосы). По умолчанию значение равно 1.0.
ZoomInCommand Увеличивает масштаб страниц ContentScale.
ZoomOutCommand Уменьшает масштаб страниц ContentScale.
ZoomPanelIsCollapsed Признак того, что нижняя панель предпросмотра с зумом и переключением режимов качества и вписывания не отображается. Не влияет на возможность использовать эти функции из API, горячими клавишами и жестами. По умолчанию false.

Методы

ApplyOptions Применяет настройки в соответствии с указанным объектом.
BeginMove Запрашивает перемещение полосы прокрутки на страницу с указанным номером. Возвращает признак того, что перемещение успешно запрошено.
CalculateRecommendedMaxImageWidth Устанавливает рекомендуемое значение для свойства MaxImageWidth. Метод должен быть вызван из потока UI.
CalculateRecommendedMaxImageWidthAsync Устанавливает рекомендуемое значение для свойства MaxImageWidth. Метод должен быть вызван из потока, отличного от потока UI.
CloseFullScreenAsync Закрывает окно полноэкранного режима. Возвращает признак того, что закрытие успешное.
CoercePageIndexFromPages Преобразует индекс из списка страниц Pages к отсчитываемому от нуля индексу страницы документа. Возвращает -1, если индекс не соответствует действительной странице.
CoercePageIndexFromPreviewPages Преобразует индекс из списка страниц предпросмотра PreviewPages к отсчитываемому от нуля индексу страницы документа. Возвращает -1, если индекс не соответствует действительной странице.
CoercePageIndexToPages Преобразует отсчитываемый от нуля индекс страницы документа к индексу в списке страниц Pages. Возвращает -1, если индекс не соответствует действительной странице.
CoercePageIndexToPreviewPages Преобразует отсчитываемый от нуля индекс страницы документа к индексу в списке страниц предпросмотра PreviewPages. Возвращает -1, если индекс не соответствует действительной странице.
DisposeAsyncPerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
EqualsDetermines whether the specified object is equal to the current object.
(Унаследован от Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Унаследован от Object)
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
LaunchMaintenanceAsync Запускает обслуживание. Гарантирует, что не останутся "висящими" незагруженные страницы.
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
OnModelPropertyChanged
(Унаследован от ViewModelTModel)
OnPropertyChanged(PropertyChangedEventArgs) Уведомляет об изменении свойства с именем, заданным в аргументах события.
(Унаследован от NotificationObject)
OnPropertyChanged(String) Уведомляет об изменении свойства с заданным именем у объекта.
(Унаследован от NotificationObject)
OnPropertyChangedAsync(PropertyChangedEventArgs, Boolean) Уведомляет об изменении свойства с именем, заданным в аргументах события, асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно.
(Унаследован от NotificationUIObject)
OnPropertyChangedAsync(String, Boolean) Уведомляет об изменении свойства с заданным именем у объекта асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно.
(Унаследован от NotificationObject)
OnReceiveWeakEvent
(Унаследован от ViewModelTModel)
SetFilePathAsync Загружает в контрол файл по заданному пути.
ShowFullScreenAsync Отображает предпросмотр в диалоге, развёрнутом на весь экран, если диалог уже не запущен в полноэкранном режиме. Метод необходимо запускать в потоке UI. Метод возвращает управление, когда диалог закрыт.
SwitchPagingModeAsync Переключает предпросмотр в постраничный режим, если поддержка такого переключения была добавлена при создании контрола.
ToStringReturns a string that represents the current object.
(Унаследован от Object)
Trace Записывает информацию по трассировке страниц.
TrySelectPreviewItem Выбирает страницу предпросмотра с указанным индексом. Возвращает признак того, что указанный элемент не был выбран, но стал выбран после выполнения метода.
UnloadAsync Выполняет выгрузку текущего отображаемого файла, если он имеется, и возвращает файл был загружен перед выгрузкой (т.е. в нём была хотя бы одна страница).
ZoomIn Увеличивает масштаб на указанный шаг.
ZoomOut Уменьшает масштаб на указанный шаг.

События

Disposed Событие, выполняемое при очистке данных контрола, что делает невозможным его использование.
PropertyChangedСобытие, уведомляющее об изменении свойства с определённым именем у модели представления.
(Унаследован от NotificationObject)
ScrollToPageSuggested Событие, определяющее необходимость переместить скролл к указанной странице.

Методы расширения

Get
(Определяется ComHelper)
Invoke
(Определяется ComHelper)
Set
(Определяется ComHelper)

См. также