C# Класс SIL.FieldWorks.Common.Controls.BulkEditBar.BulkEditTabPageSettings

This is the base class that knows common settings used in BulkEdit tabs. Used to persist those values.
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
m_bulkEditBar BulkEditBar

Private Properties

Свойство Тип Описание
BuildCurrentTabSettingsKey string
BuildLastTabSettingsKey string
CaptureSettingsForCurrentTab BulkEditTabPageSettings
DeserializeLastTabPageSettings BulkEditTabPageSettings
DeserializeTabPageSettings BulkEditTabPageSettings
GetBulkEditBarToolId string
GetNewSettingsForSelectedTab BulkEditTabPageSettings
InExpectedTab bool
InitializeSelectedTab void
SerializeSettings string
SetTargetCombo void
TryGetSettingsForCurrentTabPage bool
TrySwitchToLastSavedTab bool

Открытые методы

Метод Описание
BulkEditTabPageSettings ( ) : System

Защищенные методы

Метод Описание
CanLoadFromBulkEditBar ( ) : bool

CheckExpectedTab ( ) : void

make sure bulkEditBar is in the expected tab state.

GetCurrentTabPageName ( BulkEditBar bulkEditBar ) : string

HasExpectedTargetSelected ( ) : bool

after deserializing, determine if the target combo was able to get set to the persisted value.

InvokeTargetComboSelectedIndexChanged ( ) : void

this is a hack that explictly triggers the currentTargetCombo.SelectedIndexChange delegates during initialization, since they do not fire automatically until after everything is setup.

SaveSettings ( BulkEditBar bulkEditBar ) : void

Serialize the settings for a bulk edit bar tab, and store it in the property table.

SetTargetField ( ) : void

SetupApplyPreviewButtons ( ) : void

Update Preview/Clear and Apply Button states.

SetupBulkEditBarTab ( BulkEditBar bulkEditBar ) : void

Check that we've changed to BulkEditBar to ExpectedTab, and then set BulkEditBar to those tab settings

Приватные методы

Метод Описание
BuildCurrentTabSettingsKey ( BulkEditBar bulkEditBar ) : string
BuildLastTabSettingsKey ( BulkEditBar bulkEditBar ) : string

Construct the property table key based upon the tool using this BulkEditBar.

CaptureSettingsForCurrentTab ( BulkEditBar bulkEditBar ) : BulkEditTabPageSettings

Create BulkEditBarTabPage settings for the current tab, and save them to the property table. (only effective after initialization (i.e. m_setupOrRestoredBulkEditBarTab) To restore the settings, use TrySwitchToLastSavedTab() and/or followed by InitializeSelectedTab().

DeserializeLastTabPageSettings ( BulkEditBar bulkEditBar ) : BulkEditTabPageSettings

factory returning a tab settings object, if we found them in the property table.

DeserializeTabPageSettings ( BulkEditBar bulkEditBar, string tabSettingsKey ) : BulkEditTabPageSettings
GetBulkEditBarToolId ( BulkEditBar bulkEditBar ) : string

GetNewSettingsForSelectedTab ( BulkEditBar bulkEditBar ) : BulkEditTabPageSettings
InExpectedTab ( ) : bool
InitializeSelectedTab ( BulkEditBar bulkEditBar ) : void

Try to restore settings for selected tab, otherwise use defaults.

SerializeSettings ( ) : string
SetTargetCombo ( ) : void
TryGetSettingsForCurrentTabPage ( BulkEditBar bulkEditBar, BulkEditTabPageSettings &tabPageSettings ) : bool
TrySwitchToLastSavedTab ( BulkEditBar bulkEditBar ) : bool

Restore last visited BulkEditBar tab index. After BulkEditBar finishes initializing its state and controls in that tab, finish restoring the settings in that tab with InitializeSelectedTab()

Описание методов

BulkEditTabPageSettings() публичный Метод

public BulkEditTabPageSettings ( ) : System
Результат System

CanLoadFromBulkEditBar() защищенный Метод

protected CanLoadFromBulkEditBar ( ) : bool
Результат bool

CheckExpectedTab() защищенный Метод

make sure bulkEditBar is in the expected tab state.
protected CheckExpectedTab ( ) : void
Результат void

GetCurrentTabPageName() защищенный статический Метод

protected static GetCurrentTabPageName ( BulkEditBar bulkEditBar ) : string
bulkEditBar BulkEditBar
Результат string

HasExpectedTargetSelected() защищенный Метод

after deserializing, determine if the target combo was able to get set to the persisted value.
protected HasExpectedTargetSelected ( ) : bool
Результат bool

InvokeTargetComboSelectedIndexChanged() защищенный Метод

this is a hack that explictly triggers the currentTargetCombo.SelectedIndexChange delegates during initialization, since they do not fire automatically until after everything is setup.
protected InvokeTargetComboSelectedIndexChanged ( ) : void
Результат void

SaveSettings() защищенный Метод

Serialize the settings for a bulk edit bar tab, and store it in the property table.
protected SaveSettings ( BulkEditBar bulkEditBar ) : void
bulkEditBar BulkEditBar
Результат void

SetTargetField() защищенный Метод

protected SetTargetField ( ) : void
Результат void

SetupApplyPreviewButtons() защищенный Метод

Update Preview/Clear and Apply Button states.
protected SetupApplyPreviewButtons ( ) : void
Результат void

SetupBulkEditBarTab() защищенный Метод

Check that we've changed to BulkEditBar to ExpectedTab, and then set BulkEditBar to those tab settings
protected SetupBulkEditBarTab ( BulkEditBar bulkEditBar ) : void
bulkEditBar BulkEditBar
Результат void

Описание свойств

m_bulkEditBar защищенное свойство

the bulkEditBar we're getting or settings our values
protected BulkEditBar,SIL.FieldWorks.Common.Controls m_bulkEditBar
Результат BulkEditBar